processorGAMGInterfaceField.C
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 \*---------------------------------------------------------------------------*/
25 
28 #include "lduMatrix.H"
29 
30 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
31 
32 namespace Foam
33 {
34  defineTypeNameAndDebug(processorGAMGInterfaceField, 0);
36  (
37  GAMGInterfaceField,
38  processorGAMGInterfaceField,
39  lduInterface
40  );
42  (
43  GAMGInterfaceField,
44  processorGAMGInterfaceField,
45  lduInterfaceField
46  );
47 }
48 
49 
50 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
51 
52 Foam::processorGAMGInterfaceField::processorGAMGInterfaceField
53 (
54  const GAMGInterface& GAMGCp,
55  const lduInterfaceField& fineInterface
56 )
57 :
58  GAMGInterfaceField(GAMGCp, fineInterface),
59  procInterface_(refCast<const processorGAMGInterface>(GAMGCp)),
60  doTransform_(false),
61  rank_(0)
62 {
64  refCast<const processorLduInterfaceField>(fineInterface);
65 
66  doTransform_ = p.doTransform();
67  rank_ = p.rank();
68 }
69 
70 
71 Foam::processorGAMGInterfaceField::processorGAMGInterfaceField
72 (
73  const GAMGInterface& GAMGCp,
74  const bool doTransform,
75  const int rank
76 )
77 :
78  GAMGInterfaceField(GAMGCp, doTransform, rank),
79  procInterface_(refCast<const processorGAMGInterface>(GAMGCp)),
80  doTransform_(doTransform),
81  rank_(rank)
82 {}
83 
84 
85 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
86 
88 {}
89 
90 
91 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
92 
94 (
95  scalarField&,
96  const scalarField& psiInternal,
97  const scalarField&,
98  const direction,
99  const Pstream::commsTypes commsType
100 ) const
101 {
102  label oldWarn = UPstream::warnComm;
103  UPstream::warnComm = comm();
104 
105  procInterface_.interfaceInternalField(psiInternal, scalarSendBuf_);
106 
107  if
108  (
111  )
112  {
113  // Fast path.
114  scalarReceiveBuf_.setSize(scalarSendBuf_.size());
115  outstandingRecvRequest_ = UPstream::nRequests();
117  (
119  procInterface_.neighbProcNo(),
120  reinterpret_cast<char*>(scalarReceiveBuf_.begin()),
121  scalarReceiveBuf_.byteSize(),
122  procInterface_.tag(),
123  comm()
124  );
125 
126  outstandingSendRequest_ = UPstream::nRequests();
128  (
130  procInterface_.neighbProcNo(),
131  reinterpret_cast<const char*>(scalarSendBuf_.begin()),
132  scalarSendBuf_.byteSize(),
133  procInterface_.tag(),
134  comm()
135  );
136  }
137  else
138  {
139  procInterface_.compressedSend(commsType, scalarSendBuf_);
140  }
141 
142  const_cast<processorGAMGInterfaceField&>(*this).updatedMatrix() = false;
143 
144  UPstream::warnComm = oldWarn;
145 }
146 
147 
149 (
150  scalarField& result,
151  const scalarField&,
152  const scalarField& coeffs,
153  const direction cmpt,
154  const Pstream::commsTypes commsType
155 ) const
156 {
157  if (updatedMatrix())
158  {
159  return;
160  }
161 
162  label oldWarn = UPstream::warnComm;
163  UPstream::warnComm = comm();
164 
165  const labelUList& faceCells = procInterface_.faceCells();
166 
167  if
168  (
171  )
172  {
173  // Fast path.
174  if
175  (
176  outstandingRecvRequest_ >= 0
177  && outstandingRecvRequest_ < Pstream::nRequests()
178  )
179  {
180  UPstream::waitRequest(outstandingRecvRequest_);
181  }
182  // Recv finished so assume sending finished as well.
183  outstandingSendRequest_ = -1;
184  outstandingRecvRequest_ = -1;
185 
186  // Consume straight from scalarReceiveBuf_
187 
188  // Transform according to the transformation tensor
189  transformCoupleField(scalarReceiveBuf_, cmpt);
190 
191  // Multiply the field by coefficients and add into the result
192  forAll(faceCells, elemI)
193  {
194  result[faceCells[elemI]] -= coeffs[elemI]*scalarReceiveBuf_[elemI];
195  }
196  }
197  else
198  {
199  scalarField pnf
200  (
201  procInterface_.compressedReceive<scalar>(commsType, coeffs.size())
202  );
203  transformCoupleField(pnf, cmpt);
204 
205  forAll(faceCells, elemI)
206  {
207  result[faceCells[elemI]] -= coeffs[elemI]*pnf[elemI];
208  }
209  }
210 
211  const_cast<processorGAMGInterfaceField&>(*this).updatedMatrix() = true;
212 
213  UPstream::warnComm = oldWarn;
214 }
215 
216 
217 // ************************************************************************* //
static bool floatTransfer
Should compact transfer be used in which floats replace doubles.
Definition: UPstream.H:262
virtual bool doTransform() const =0
Is the transform required.
#define forAll(list, i)
Loop across all elements in list.
Definition: UList.H:428
bool updatedMatrix() const
Whether matrix has been updated.
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
commsTypes
Types of communications.
Definition: UPstream.H:64
uint8_t direction
Definition: direction.H:45
void size(const label)
Override size to be inconsistent with allocated storage.
Definition: ListI.H:163
virtual void updateInterfaceMatrix(scalarField &result, const scalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const
Update result field based on interface functionality.
static label nRequests()
Get number of outstanding requests.
Definition: UPstream.C:107
An abstract base class for implicitly-coupled interface fields e.g. processor and cyclic patch fields...
Macros for easy insertion into run-time selection tables.
virtual int rank() const =0
Return rank of component for transform.
Abstract base class for processor coupled interfaces.
virtual void initInterfaceMatrixUpdate(scalarField &result, const scalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const
Initialise neighbour matrix update.
static label warnComm
Debugging: warn for use of any communicator differing from warnComm.
Definition: UPstream.H:278
A 1D vector of objects of type <T>, where the size of the vector is known and can be used for subscri...
Definition: HashTable.H:61
static label read(const commsTypes commsType, const int fromProcNo, char *buf, const std::streamsize bufSize, const int tag=UPstream::msgType(), const label communicator=0)
Read into given buffer from given processor and return the.
Definition: UIPread.C:79
addToRunTimeSelectionTable(ensightPart, ensightPartCells, istream)
defineTypeNameAndDebug(combustionModel, 0)
static bool write(const commsTypes commsType, const int toProcNo, const char *buf, const std::streamsize bufSize, const int tag=UPstream::msgType(), const label communicator=0)
Write given buffer to given processor.
Definition: UOPwrite.C:34
Abstract base class for GAMG agglomerated interfaces.
Definition: GAMGInterface.H:51
Abstract base class for GAMG agglomerated interface fields.
GAMG agglomerated processor interface field.
volScalarField & p
static void waitRequest(const label i)
Wait until request i has finished.
Definition: UPstream.C:121
Namespace for OpenFOAM.