Epetra Package Browser (Single Doxygen Collection) Development
Loading...
Searching...
No Matches
Epetra_Export.h
Go to the documentation of this file.
1/*
2//@HEADER
3// ************************************************************************
4//
5// Epetra: Linear Algebra Services Package
6// Copyright 2011 Sandia Corporation
7//
8// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9// the U.S. Government retains certain rights in this software.
10//
11// Redistribution and use in source and binary forms, with or without
12// modification, are permitted provided that the following conditions are
13// met:
14//
15// 1. Redistributions of source code must retain the above copyright
16// notice, this list of conditions and the following disclaimer.
17//
18// 2. Redistributions in binary form must reproduce the above copyright
19// notice, this list of conditions and the following disclaimer in the
20// documentation and/or other materials provided with the distribution.
21//
22// 3. Neither the name of the Corporation nor the names of the
23// contributors may be used to endorse or promote products derived from
24// this software without specific prior written permission.
25//
26// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37//
38// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
39//
40// ************************************************************************
41//@HEADER
42*/
43
44#ifndef EPETRA_EXPORT_H
45#define EPETRA_EXPORT_H
46
47#include "Epetra_Object.h"
48#include "Epetra_BlockMap.h"
49
51class Epetra_Import;
53
62class EPETRA_LIB_DLL_EXPORT Epetra_Export: public Epetra_Object {
63 friend class Epetra_Import;
64 public:
65
67
231 Epetra_Export( const Epetra_BlockMap & SourceMap, const Epetra_BlockMap & TargetMap );
232
234 Epetra_Export(const Epetra_Export& Exporter);
235
237 Epetra_Export(const Epetra_Import& Exporter);
238
240 virtual ~Epetra_Export(void);
241
243 int NumSameIDs() const {return(NumSameIDs_);};
244
246 int NumPermuteIDs() const {return(NumPermuteIDs_);};
247
249 int * PermuteFromLIDs () const {return(PermuteFromLIDs_);};
251 int * PermuteToLIDs () const {return(PermuteToLIDs_);};
252
254 int NumRemoteIDs() const {return(NumRemoteIDs_);};
255
257 int * RemoteLIDs() const {return(RemoteLIDs_);};
258
260 int NumExportIDs () const {return(NumExportIDs_);};
261
263 int * ExportLIDs () const {return(ExportLIDs_);};
264
266 int * ExportPIDs () const {return(ExportPIDs_);};
267
269 int NumSend() const {return(NumSend_);};
270
272 int NumRecv() const {return(NumRecv_);};
273
275 const Epetra_BlockMap & SourceMap() const {return(SourceMap_);};
276
278 const Epetra_BlockMap & TargetMap() const {return(TargetMap_);};
279
280 Epetra_Distributor & Distributor() const {return(*Distor_);};
281
282 const Epetra_Distributor * DistributorPtr() const {return(Distor_);}
283
285
286 virtual void Print(std::ostream & os) const;
288 protected:
289
290 friend class Epetra_BlockMap;
291
292 private:
294
297
304
308
311
313
314 template<typename int_type>
315 void Construct(const Epetra_BlockMap & SourceMap, const Epetra_BlockMap & TargetMap);
316
317};
318
319#endif /* EPETRA_EXPORT_H */
Epetra_BlockMap: A class for partitioning block element vectors and matrices.
Epetra_Distributor: The Epetra Gather/Scatter Setup Base Class.
Epetra_Export: This class builds an export object for efficient exporting of off-processor elements.
Definition: Epetra_Export.h:62
int * RemoteLIDs() const
List of elements in the target map that are coming from other processors.
int * PermuteToLIDs_
const Epetra_BlockMap & TargetMap() const
Returns the TargetMap used to construct this exporter.
Epetra_Distributor & Distributor() const
int NumRemoteIDs() const
Returns the number of elements that are not on the calling processor.
const Epetra_BlockMap & SourceMap() const
Returns the SourceMap used to construct this exporter.
int * PermuteToLIDs() const
List of elements in the target map that are permuted.
Epetra_BlockMap TargetMap_
int NumPermuteIDs() const
Returns the number of elements that are local to the calling processor, but not part of the first Num...
int * ExportPIDs() const
List of processors to which elements will be sent, ExportLIDs() [i] will be sent to processor ExportP...
Epetra_BlockMap SourceMap_
int * PermuteFromLIDs() const
List of elements in the source map that are permuted.
int NumSameIDs() const
Returns the number of elements that are identical between the source and target maps,...
int NumSend() const
Total number of elements to be sent.
int NumRecv() const
Total number of elements to be received.
int * ExportLIDs() const
List of elements that will be sent to other processors.
int NumExportIDs() const
Returns the number of elements that must be sent by the calling processor to other processors.
Epetra_Distributor * Distor_
int * PermuteFromLIDs_
const Epetra_Distributor * DistributorPtr() const
Epetra_Import: This class builds an import object for efficient importing of off-processor elements.
Definition: Epetra_Import.h:63
Epetra_Object: The base Epetra class.
Definition: Epetra_Object.h:57
virtual void Print(std::ostream &os) const
Print object to an output stream Print method.
Epetra_Object & operator=(const Epetra_Object &src)