cyclicPointPatchField.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-2017 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::cyclicPointPatchField
26 
27 Description
28  Cyclic front and back plane patch field
29 
30 SourceFiles
31  cyclicPointPatchField.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef cyclicPointPatchField_H
36 #define cyclicPointPatchField_H
37 
38 #include "coupledPointPatchField.H"
39 #include "cyclicPointPatch.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class cyclicPointPatchField Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 template<class Type>
52 :
53  public coupledPointPatchField<Type>
54 {
55  // Private data
56 
57  //- Local reference cast into the cyclic patch
58  const cyclicPointPatch& cyclicPatch_;
59 
60 
61 public:
62 
63  //- Runtime type information
64  TypeName(cyclicPointPatch::typeName_());
65 
66 
67  // Constructors
68 
69  //- Construct from patch and internal field
71  (
72  const pointPatch&,
74  );
75 
76  //- Construct from patch, internal field and dictionary
78  (
79  const pointPatch&,
81  const dictionary&
82  );
83 
84  //- Construct by mapping given patchField<Type> onto a new patch
86  (
88  const pointPatch&,
91  );
92 
93  //- Construct and return a clone
94  virtual autoPtr<pointPatchField<Type>> clone() const
95  {
97  (
99  (
100  *this
101  )
102  );
103  }
104 
105  //- Construct as copy setting internal field reference
107  (
110  );
111 
112  //- Construct and return a clone setting internal field reference
114  (
116  ) const
117  {
119  (
121  (
122  *this, iF
123  )
124  );
125  }
126 
127 
128  // Member functions
129 
130  //- Constraint handling
131 
132  //- Return the constraint type this pointPatchField implements
133  virtual const word& constraintType() const
134  {
135  return cyclicPointPatch::typeName;
136  }
137 
138  //- Cyclic coupled interface functions
139 
140  //- Does the patch field perform the transfromation
141  virtual bool doTransform() const
142  {
143  return !(cyclicPatch_.parallel() || pTraits<Type>::rank == 0);
144  }
145 
146  //- Return face transformation tensor
147  virtual const tensorField& forwardT() const
148  {
149  return cyclicPatch_.forwardT();
150  }
151 
152  //- Return neighbour-cell transformation tensor
153  virtual const tensorField& reverseT() const
154  {
155  return cyclicPatch_.reverseT();
156  }
157 
158 
159  // Evaluation functions
160 
161  //- Evaluate the patch field
162  virtual void evaluate
163  (
164  const Pstream::commsTypes commsType =
166  )
167  {}
168 
169  //- Complete swap of patch point values and add to local values
170  virtual void swapAddSeparated
171  (
172  const Pstream::commsTypes commsType,
173  Field<Type>&
174  ) const;
175 };
176 
177 
178 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
179 
180 } // End namespace Foam
181 
182 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
183 
184 #ifdef NoRepository
185  #include "cyclicPointPatchField.C"
186 #endif
187 
188 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
189 
190 #endif
191 
192 // ************************************************************************* //
virtual autoPtr< pointPatchField< Type > > clone() const
Construct and return a clone.
TypeName(cyclicPointPatch::typeName_())
Runtime type information.
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
virtual bool doTransform() const
Cyclic coupled interface functions.
Foam::pointPatchFieldMapper.
Traits class for primitives.
Definition: pTraits.H:50
Cyclic front and back plane patch field.
const tensorField & forwardT() const
Return face transformation tensor.
Cyclic patch for post-processing.
virtual const tensorField & reverseT() const
Return neighbour-cell transformation tensor.
A class for handling words, derived from string.
Definition: word.H:59
virtual void swapAddSeparated(const Pstream::commsTypes commsType, Field< Type > &) const
Complete swap of patch point values and add to local values.
virtual const tensorField & forwardT() const
Return face transformation tensor.
virtual const word & constraintType() const
Constraint handling.
Basic pointPatch represents a set of points from the mesh.
Definition: pointPatch.H:56
A Coupled boundary condition for pointField.
const tensorField & reverseT() const
Return neighbour-cell transformation tensor.
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
cyclicPointPatchField(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
bool parallel() const
Are the cyclic planes parallel.
virtual void evaluate(const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
Evaluate the patch field.
Namespace for OpenFOAM.