escript  Revision_
Coupler.h
Go to the documentation of this file.
1 
2 /*****************************************************************************
3 *
4 * Copyright (c) 2003-2020 by The University of Queensland
5 * http://www.uq.edu.au
6 *
7 * Primary Business: Queensland, Australia
8 * Licensed under the Apache License, version 2.0
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Development until 2012 by Earth Systems Science Computational Center (ESSCC)
12 * Development 2012-2013 by School of Earth Sciences
13 * Development from 2014-2017 by Centre for Geoscience Computing (GeoComp)
14 * Development from 2019 by School of Earth and Environmental Sciences
15 **
16 *****************************************************************************/
17 
18 
19 /****************************************************************************/
20 
21 /* Paso: coupler */
22 
23 /****************************************************************************/
24 
25 /* Author: Lutz Gross, l.gross@uq.edu.au */
26 
27 /****************************************************************************/
28 
29 #ifndef __PASO_COUPLER_H__
30 #define __PASO_COUPLER_H__
31 
32 #include "Paso.h"
33 #include "PasoException.h"
34 #include "SharedComponents.h"
35 
36 namespace paso {
37 
38 struct Connector;
39 typedef boost::shared_ptr<Connector> Connector_ptr;
40 typedef boost::shared_ptr<const Connector> const_Connector_ptr;
41 
42 template<typename Scalar> struct Coupler;
43 template<typename T> using Coupler_ptr = boost::shared_ptr<Coupler<T> >;
44 template<typename T> using const_Coupler_ptr = boost::shared_ptr<const Coupler<T> >;
45 
47 {
50 
52  {
53  if (s->local_length != r->local_length) {
54  throw PasoException("Connector: local length of send and recv "
55  "SharedComponents must match.");
56  }
57  send = s;
58  recv = r;
59  }
60 
62  inline Connector_ptr copy() const { return unroll(1); }
63 
64  inline Connector_ptr unroll(index_t block_size) const
65  {
66  SharedComponents_ptr new_send_shcomp, new_recv_shcomp;
67  Connector_ptr out;
68  if (block_size > 1) {
69  new_send_shcomp.reset(new SharedComponents(send->local_length,
70  send->neighbour, send->shared, send->offsetInShared,
71  block_size, 0));
72 
73  new_recv_shcomp.reset(new SharedComponents(recv->local_length,
74  recv->neighbour, recv->shared, recv->offsetInShared,
75  block_size, 0));
76  } else {
77  new_send_shcomp = send;
78  new_recv_shcomp = recv;
79  }
80  out.reset(new Connector(new_send_shcomp, new_recv_shcomp));
81  return out;
82  }
83 
84  //inline debug() const
85  //{
86  // for (int i=0; i<recv->neighbour.size(); ++i)
87  // printf("Coupler: %d receive %d data at %d from %d\n",
88  // s->mpi_info->rank,recv->offsetInShared[i+1]-recv->offsetInShared[i],
89  // recv->offsetInShared[i],recv->neighbour[i]);
90  // for (int i=0; i<send->neighbour.size(); ++i)
91  // printf("Coupler: %d send %d data at %d to %d\n",
92  // s->mpi_info->rank,send->offsetInShared[i+1]-send->offsetInShared[i],
93  // send->offsetInShared[i],send->neighbour[i]);
94  //}
95 };
96 
97 
98 template<typename Scalar>
100 {
101  Coupler(const_Connector_ptr, dim_t blockSize, escript::JMPI mpiInfo);
102  ~Coupler();
103 
104  void startCollect(const Scalar* in);
105  Scalar* finishCollect();
106  void copyAll(Coupler_ptr<Scalar> target) const;
107  void fillOverlap(dim_t n, Scalar* x);
108  void max(dim_t n, Scalar* x);
109 
110  inline const Scalar* borrowLocalData() const { return data; }
111 
112  inline const Scalar* borrowRemoteData() const { return recv_buffer; }
113 
115  {
116  return connector->send->numSharedComponents;
117  }
118 
120  {
121  return connector->recv->numSharedComponents;
122  }
123 
124  inline dim_t getNumSharedValues() const
125  {
126  return getNumSharedComponents() * block_size;
127  }
128 
129  inline dim_t getNumOverlapValues() const
130  {
131  return getNumOverlapComponents() * block_size;
132  }
133 
134  inline dim_t getLocalLength() const
135  {
136  return connector->send->local_length;
137  }
138 
141  bool in_use;
142 
143  // unmanaged pointer to data to be sent
150 };
151 
152 
153 } // namespace paso
154 
155 #endif // __PASO_COUPLER_H__
156 
speckley::Brick::gradient_order3
void gradient_order3(escript::Data &, const escript::Data &) const
Definition: BrickGradients.cpp:84
MPI_Status
int MPI_Status
Definition: EsysMPI.h:47
paso::Coupler::block_size
dim_t block_size
Definition: Coupler.h:140
paso::Connector::recv
SharedComponents_ptr recv
Definition: Coupler.h:49
speckley::Brick::reduction_order2
void reduction_order2(const escript::Data &, escript::Data &) const
Definition: BrickReductions.cpp:25
speckley::Brick::integral_order2
void integral_order2(std::vector< Scalar > &, const escript::Data &) const
Definition: BrickIntegrals.cpp:25
PASO_DLL_API
#define PASO_DLL_API
Definition: paso/src/system_dep.h:29
speckley::Brick::gradient_order2
void gradient_order2(escript::Data &, const escript::Data &) const
Definition: BrickGradients.cpp:25
escript::DataTypes::real_t
double real_t
type of all real-valued scalars in escript
Definition: DataTypes.h:52
paso::const_Coupler_ptr
boost::shared_ptr< const Coupler< T > > const_Coupler_ptr
Definition: Coupler.h:44
paso::Coupler::borrowLocalData
const Scalar * borrowLocalData() const
Definition: Coupler.h:110
speckley::Brick::reduction_order10
void reduction_order10(const escript::Data &, escript::Data &) const
Definition: BrickReductions.cpp:234
paso::Coupler::getNumSharedValues
dim_t getNumSharedValues() const
Definition: Coupler.h:124
speckley::Brick::gradient_order6
void gradient_order6(escript::Data &, const escript::Data &) const
Definition: BrickGradients.cpp:268
paso::Coupler::borrowRemoteData
const Scalar * borrowRemoteData() const
Definition: Coupler.h:112
paso::Coupler::copyAll
void copyAll(Coupler_ptr< Scalar > target) const
Definition: Coupler.cpp:131
escript::Data::requireWrite
void requireWrite()
Ensures data is ready for write access. This means that the data will be resolved if lazy and will be...
Definition: Data.cpp:1239
paso::const_Connector_ptr
boost::shared_ptr< const Connector > const_Connector_ptr
Definition: Coupler.h:40
INDEX4
#define INDEX4(_X1_, _X2_, _X3_, _X4_, _N1_, _N2_, _N3_)
Definition: index.h:27
speckley::Brick::gradient_order10
void gradient_order10(escript::Data &, const escript::Data &) const
Definition: BrickGradients.cpp:530
paso::Coupler::getNumOverlapValues
dim_t getNumOverlapValues() const
Definition: Coupler.h:129
speckley::Brick::reduction_order4
void reduction_order4(const escript::Data &, escript::Data &) const
Definition: BrickReductions.cpp:78
speckley::Brick::gradient_order7
void gradient_order7(escript::Data &, const escript::Data &) const
Definition: BrickGradients.cpp:332
escript::Data::getSampleDataRO
const DataTypes::real_t * getSampleDataRO(DataTypes::RealVectorType::size_type sampleNo, DataTypes::real_t dummy=0) const
Return the sample data for the given sample no. Please do not use this unless you NEED to access samp...
Definition: Data.h:1991
paso::Coupler
Definition: Coupler.h:100
speckley::Brick::integral_order6
void integral_order6(std::vector< Scalar > &, const escript::Data &) const
Definition: BrickIntegrals.cpp:142
speckley::Brick::integral_order5
void integral_order5(std::vector< Scalar > &, const escript::Data &) const
Definition: BrickIntegrals.cpp:113
speckley::Brick::gradient_order4
void gradient_order4(escript::Data &, const escript::Data &) const
Definition: BrickGradients.cpp:143
speckley::Brick::integral_order3
void integral_order3(std::vector< Scalar > &, const escript::Data &) const
Definition: BrickIntegrals.cpp:55
paso::Coupler::connector
const_Connector_ptr connector
Definition: Coupler.h:139
speckley::Brick::reduction_order3
void reduction_order3(const escript::Data &, escript::Data &) const
Definition: BrickReductions.cpp:52
paso::Coupler::send_buffer
Scalar * send_buffer
Definition: Coupler.h:145
paso::SharedComponents
Definition: SharedComponents.h:41
paso::Connector::copy
Connector_ptr copy() const
creates a copy
Definition: Coupler.h:62
INDEX5
#define INDEX5(_X1_, _X2_, _X3_, _X4_, _X5_, _N1_, _N2_, _N3_, _N4_)
Definition: index.h:29
escript::Data::getDataPointSize
int getDataPointSize() const
Return the size of the data point. It is the product of the data point shape dimensions.
Definition: Data.cpp:1360
paso::Connector
Definition: Coupler.h:47
speckley::Brick::integral_order4
void integral_order4(std::vector< Scalar > &, const escript::Data &) const
Definition: BrickIntegrals.cpp:84
paso::Coupler::mpi_info
escript::JMPI mpi_info
Definition: Coupler.h:149
speckley::Brick::integral_order7
void integral_order7(std::vector< Scalar > &, const escript::Data &) const
Definition: BrickIntegrals.cpp:171
speckley
Definition: AbstractAssembler.cpp:19
paso::Coupler::startCollect
void startCollect(const Scalar *in)
Definition: Coupler.cpp:66
paso::Coupler::mpi_stati
MPI_Status * mpi_stati
Definition: Coupler.h:148
Paso.h
escript::Data
Data represents a collection of datapoints.
Definition: Data.h:64
paso::Coupler::Coupler
Coupler(const_Connector_ptr, dim_t blockSize, escript::JMPI mpiInfo)
Definition: Coupler.cpp:30
INDEX3
#define INDEX3(_X1_, _X2_, _X3_, _N1_, _N2_)
Definition: index.h:25
escript::DataTypes::dim_t
index_t dim_t
Definition: DataTypes.h:66
escript::JMPI
boost::shared_ptr< JMPI_ > JMPI
Definition: EsysMPI.h:74
escript::Data::getSampleDataRW
DataTypes::real_t * getSampleDataRW(DataTypes::RealVectorType::size_type sampleNo, DataTypes::real_t dummy=0)
Return the sample data for the given sample no. Please do not use this unless you NEED to access samp...
Definition: Data.h:1956
paso::Coupler_ptr
boost::shared_ptr< Coupler< T > > Coupler_ptr
Definition: Coupler.h:43
speckley::Brick::gradient_order8
void gradient_order8(escript::Data &, const escript::Data &) const
Definition: BrickGradients.cpp:397
speckley::Brick::reduction_order7
void reduction_order7(const escript::Data &, escript::Data &) const
Definition: BrickReductions.cpp:156
paso::Coupler::max
void max(dim_t n, Scalar *x)
paso::Coupler::finishCollect
Scalar * finishCollect()
Definition: Coupler.cpp:114
paso::Coupler::getNumSharedComponents
dim_t getNumSharedComponents() const
Definition: Coupler.h:114
speckley::Brick::integral_order8
void integral_order8(std::vector< Scalar > &, const escript::Data &) const
Definition: BrickIntegrals.cpp:200
paso::Coupler::mpi_requests
MPI_Request * mpi_requests
Definition: Coupler.h:147
paso::Coupler::~Coupler
~Coupler()
Definition: Coupler.cpp:55
paso::SharedComponents_ptr
boost::shared_ptr< SharedComponents > SharedComponents_ptr
Definition: SharedComponents.h:36
paso::Coupler::in_use
bool in_use
Definition: Coupler.h:141
SharedComponents.h
speckley::Brick::integral_order9
void integral_order9(std::vector< Scalar > &, const escript::Data &) const
Definition: BrickIntegrals.cpp:229
paso::Connector::unroll
Connector_ptr unroll(index_t block_size) const
Definition: Coupler.h:64
speckley::Brick::m_dx
double m_dx[3]
grid spacings / cell sizes of domain
Definition: speckley/src/Brick.h:358
MPI_DOUBLE
#define MPI_DOUBLE
Definition: EsysMPI.h:49
paso::Coupler::getNumOverlapComponents
dim_t getNumOverlapComponents() const
Definition: Coupler.h:119
speckley::Brick::gradient_order9
void gradient_order9(escript::Data &, const escript::Data &) const
Definition: BrickGradients.cpp:463
paso::PasoException
PasoException exception class.
Definition: PasoException.h:34
paso::Coupler::recv_buffer
Scalar * recv_buffer
Definition: Coupler.h:146
speckley::Brick::integral_order10
void integral_order10(std::vector< Scalar > &, const escript::Data &) const
Definition: BrickIntegrals.cpp:258
escript::DataTypes::index_t
int index_t
type for array/matrix indices used both globally and on each rank
Definition: DataTypes.h:61
speckley::Brick::m_NE
dim_t m_NE[3]
number of elements for this rank in each dimension including shared
Definition: speckley/src/Brick.h:364
speckley::Brick::gradient_order5
void gradient_order5(escript::Data &, const escript::Data &) const
Definition: BrickGradients.cpp:205
paso::Coupler::data
Scalar * data
Definition: Coupler.h:144
speckley::Brick::reduction_order5
void reduction_order5(const escript::Data &, escript::Data &) const
Definition: BrickReductions.cpp:104
paso::Coupler::fillOverlap
void fillOverlap(dim_t n, Scalar *x)
Definition: Coupler.cpp:149
paso::Connector::send
SharedComponents_ptr send
Definition: Coupler.h:48
speckley::Brick::reduction_order6
void reduction_order6(const escript::Data &, escript::Data &) const
Definition: BrickReductions.cpp:130
MPI_Request
int MPI_Request
Definition: EsysMPI.h:45
PasoException.h
paso::Connector_ptr
boost::shared_ptr< Connector > Connector_ptr
Definition: Coupler.h:38
escript::Data::actsExpanded
bool actsExpanded() const
Return true if this Data is expanded or resolves to expanded. That is, if it has a separate value for...
Definition: Data.cpp:1118
Coupler.h
paso
Definition: BiCGStab.cpp:25
escript::DataTypes::cplx_t
std::complex< real_t > cplx_t
complex data type
Definition: DataTypes.h:55
escript::Scalar
Data Scalar(double value, const FunctionSpace &what, bool expanded)
A collection of factory functions for creating Data objects which contain data points of various shap...
Definition: DataFactory.cpp:49
paso::Connector::Connector
Connector(SharedComponents_ptr s, SharedComponents_ptr r)
Definition: Coupler.h:51
speckley::Brick::reduction_order9
void reduction_order9(const escript::Data &, escript::Data &) const
Definition: BrickReductions.cpp:208
paso::Coupler::getLocalLength
dim_t getLocalLength() const
Definition: Coupler.h:134
speckley::Brick::reduction_order8
void reduction_order8(const escript::Data &, escript::Data &) const
Definition: BrickReductions.cpp:182