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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2017 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::cyclicPointPatchField
28 
29 Description
30  Cyclic front and back plane patch field
31 
32 SourceFiles
33  cyclicPointPatchField.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef cyclicPointPatchField_H
38 #define cyclicPointPatchField_H
39 
40 #include "coupledPointPatchField.H"
41 #include "cyclicPointPatch.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class cyclicPointPatchField Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 template<class Type>
54 :
55  public coupledPointPatchField<Type>
56 {
57  // Private data
58 
59  //- Local reference cast into the cyclic patch
60  const cyclicPointPatch& cyclicPatch_;
61 
62 
63 public:
64 
65  //- Runtime type information
66  TypeName(cyclicPointPatch::typeName_());
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 and return a clone
96  virtual autoPtr<pointPatchField<Type>> clone() const
97  {
99  (
101  (
102  *this
103  )
104  );
105  }
106 
107  //- Construct as copy setting internal field reference
109  (
112  );
113 
114  //- Construct and return a clone setting internal field reference
116  (
118  ) const
119  {
121  (
123  (
124  *this, iF
125  )
126  );
127  }
128 
129 
130  // Member functions
131 
132  //- Constraint handling
133 
134  //- Return the constraint type this pointPatchField implements
135  virtual const word& constraintType() const
136  {
137  return cyclicPointPatch::typeName;
138  }
139 
140  //- Cyclic coupled interface functions
141 
142  //- Does the patch field perform the transformation
143  virtual bool doTransform() const
144  {
145  return !(cyclicPatch_.parallel() || pTraits<Type>::rank == 0);
146  }
147 
148  //- Return face transformation tensor
149  virtual const tensorField& forwardT() const
150  {
151  return cyclicPatch_.forwardT();
152  }
153 
154  //- Return neighbour-cell transformation tensor
155  virtual const tensorField& reverseT() const
156  {
157  return cyclicPatch_.reverseT();
158  }
159 
160 
161  // Evaluation functions
162 
163  //- Evaluate the patch field
164  virtual void evaluate
165  (
166  const Pstream::commsTypes commsType =
168  )
169  {}
170 
171  //- Complete swap of patch point values and add to local values
172  virtual void swapAddSeparated
173  (
174  const Pstream::commsTypes commsType,
175  Field<Type>&
176  ) const;
177 };
178 
179 
180 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
181 
182 } // End namespace Foam
183 
184 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
185 
186 #ifdef NoRepository
187  #include "cyclicPointPatchField.C"
188 #endif
189 
190 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
191 
192 #endif
193 
194 // ************************************************************************* //
Foam::cyclicPointPatch::reverseT
const tensorField & reverseT() const
Return neighbour-cell transformation tensor.
Definition: cyclicPointPatch.H:149
Foam::UPstream::commsTypes::blocking
coupledPointPatchField.H
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:62
Foam::coupledPointPatchField
A Coupled boundary condition for pointField.
Definition: coupledPointPatchField.H:52
Foam::cyclicPointPatchField::reverseT
virtual const tensorField & reverseT() const
Return neighbour-cell transformation tensor.
Definition: cyclicPointPatchField.H:154
Foam::cyclicPointPatchField::evaluate
virtual void evaluate(const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
Evaluate the patch field.
Definition: cyclicPointPatchField.H:164
Foam::cyclicPointPatchField::clone
virtual autoPtr< pointPatchField< Type > > clone() const
Construct and return a clone.
Definition: cyclicPointPatchField.H:95
Foam::cyclicPointPatchField::TypeName
TypeName(cyclicPointPatch::typeName_())
Runtime type information.
Foam::pointPatch
Basic pointPatch represents a set of points from the mesh.
Definition: pointPatch.H:58
Foam::cyclicPointPatch
Cyclic patch for post-processing.
Definition: cyclicPointPatch.H:52
Foam::pointPatchFieldMapper
Foam::pointPatchFieldMapper.
Definition: pointPatchFieldMapper.H:48
Foam::cyclicPointPatchField::swapAddSeparated
virtual void swapAddSeparated(const Pstream::commsTypes commsType, Field< Type > &) const
Complete swap of patch point values and add to local values.
Definition: cyclicPointPatchField.C:108
Foam::cyclicPointPatchField::doTransform
virtual bool doTransform() const
Cyclic coupled interface functions.
Definition: cyclicPointPatchField.H:142
Foam::cyclicPointPatch::forwardT
const tensorField & forwardT() const
Return face transformation tensor.
Definition: cyclicPointPatch.H:143
Foam::Field< tensor >
Foam::cyclicPointPatchField::constraintType
virtual const word & constraintType() const
Constraint handling.
Definition: cyclicPointPatchField.H:134
Foam::cyclicPointPatch::parallel
bool parallel() const
Are the cyclic planes parallel.
Definition: cyclicPointPatch.H:137
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
Foam::cyclicPointPatchField::forwardT
virtual const tensorField & forwardT() const
Return face transformation tensor.
Definition: cyclicPointPatchField.H:148
cyclicPointPatch.H
Foam::cyclicPointPatchField
Cyclic front and back plane patch field.
Definition: cyclicPointPatchField.H:52
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::cyclicPointPatchField::cyclicPointPatchField
cyclicPointPatchField(const pointPatch &, const DimensionedField< Type, pointMesh > &)
Construct from patch and internal field.
Definition: cyclicPointPatchField.C:37
Foam::autoPtr
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
Foam::UPstream::commsTypes
commsTypes
Types of communications.
Definition: UPstream.H:66
Foam::pTraits
Traits class for primitives.
Definition: pTraits.H:54
cyclicPointPatchField.C
Foam::DimensionedField
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Definition: DimensionedField.H:54