processorGAMGInterfaceField.C
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 \*---------------------------------------------------------------------------*/
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  procInterface_.interfaceInternalField(psiInternal, scalarSendBuf_);
103 
104  if
105  (
108  )
109  {
110  // Fast path.
111  scalarReceiveBuf_.setSize(scalarSendBuf_.size());
112  outstandingRecvRequest_ = UPstream::nRequests();
114  (
116  procInterface_.neighbProcNo(),
117  reinterpret_cast<char*>(scalarReceiveBuf_.begin()),
118  scalarReceiveBuf_.byteSize(),
119  procInterface_.tag(),
120  comm()
121  );
122 
123  outstandingSendRequest_ = UPstream::nRequests();
125  (
127  procInterface_.neighbProcNo(),
128  reinterpret_cast<const char*>(scalarSendBuf_.begin()),
129  scalarSendBuf_.byteSize(),
130  procInterface_.tag(),
131  comm()
132  );
133  }
134  else
135  {
136  procInterface_.compressedSend(commsType, scalarSendBuf_);
137  }
138 
139  const_cast<processorGAMGInterfaceField&>(*this).updatedMatrix() = false;
140 }
141 
142 
144 (
145  scalarField& result,
146  const scalarField&,
147  const scalarField& coeffs,
148  const direction cmpt,
149  const Pstream::commsTypes commsType
150 ) const
151 {
152  if (updatedMatrix())
153  {
154  return;
155  }
156 
157  const labelUList& faceCells = procInterface_.faceCells();
158 
159  if
160  (
163  )
164  {
165  // Fast path.
166  if
167  (
168  outstandingRecvRequest_ >= 0
169  && outstandingRecvRequest_ < Pstream::nRequests()
170  )
171  {
172  UPstream::waitRequest(outstandingRecvRequest_);
173  }
174  // Recv finished so assume sending finished as well.
175  outstandingSendRequest_ = -1;
176  outstandingRecvRequest_ = -1;
177 
178  // Consume straight from scalarReceiveBuf_
179 
180  // Transform according to the transformation tensor
181  transformCoupleField(scalarReceiveBuf_, cmpt);
182 
183  // Multiply the field by coefficients and add into the result
184  forAll(faceCells, elemI)
185  {
186  result[faceCells[elemI]] -= coeffs[elemI]*scalarReceiveBuf_[elemI];
187  }
188  }
189  else
190  {
191  scalarField pnf
192  (
193  procInterface_.compressedReceive<scalar>(commsType, coeffs.size())
194  );
195  transformCoupleField(pnf, cmpt);
196 
197  forAll(faceCells, elemI)
198  {
199  result[faceCells[elemI]] -= coeffs[elemI]*pnf[elemI];
200  }
201  }
202 
203  const_cast<processorGAMGInterfaceField&>(*this).updatedMatrix() = true;
204 }
205 
206 
207 // ************************************************************************* //
static bool floatTransfer
Should compact transfer be used in which floats replace doubles.
Definition: UPstream.H:265
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.
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:137
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.
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:151
Namespace for OpenFOAM.