escript  Revision_
speckley/src/Rectangle.h
Go to the documentation of this file.
1 
2 /*****************************************************************************
3 *
4 * Copyright (c) 2003-2018 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 by Centre for Geoscience Computing (GeoComp)
14 *
15 *****************************************************************************/
16 
17 #ifndef __SPECKLEY_RECTANGLE_H__
18 #define __SPECKLEY_RECTANGLE_H__
19 
20 #include <speckley/SpeckleyDomain.h>
21 
22 namespace speckley {
23 
24 #ifdef USE_RIPLEY
25 class RipleyCoupler; //forward declaration of coupler to avoid circles
26 #endif
27 
32 class Speckley_DLL_API Rectangle: public SpeckleyDomain
33 {
34 public:
35 
43  Rectangle(int order, dim_t n0, dim_t n1, double x0, double y0,
44  double x1, double y1, int d0=-1, int d1=-1,
45  const std::vector<double>& points = std::vector<double>(),
46  const std::vector<int>& tags = std::vector<int>(),
47  const TagMap& tagnamestonums = TagMap(),
49  );
50 
55  ~Rectangle();
56 
61  virtual std::string getDescription() const;
62 
66  virtual bool operator==(const escript::AbstractDomain& other) const;
67 
73  virtual void write(const std::string& filename) const;
74 
80  void dump(const std::string& filename) const;
81 
84  virtual void readNcGrid(escript::Data& out, std::string filename,
85  std::string varname, const ReaderParameters& params) const;
86 
89  virtual void readBinaryGrid(escript::Data& out, std::string filename,
90  const ReaderParameters& params) const;
91 
94  virtual void readBinaryGridFromZipped(escript::Data& out,
95  std::string filename, const ReaderParameters& params) const;
96 
99  virtual void writeBinaryGrid(const escript::Data& in,
100  std::string filename,
101  int byteOrder, int dataType) const;
102 
108  const dim_t* borrowSampleReferenceIDs(int fsType) const;
109 
114  virtual bool ownSample(int fs_code, index_t id) const;
115 
122  virtual void setToNormal(escript::Data& out) const;
123 
129  virtual void setToSize(escript::Data& out) const;
130 
135  virtual dim_t getNumDataPointsGlobal() const;
136 
142  virtual void Print_Mesh_Info(const bool full=false) const;
143 
148  virtual const dim_t* getNumNodesPerDim() const { return m_NN; }
149 
154  virtual const dim_t* getNumElementsPerDim() const { return m_NE; }
155 
161  virtual const dim_t* getNumFacesPerBoundary() const { return m_faceCount; }
162 
167  virtual IndexVector getNodeDistribution() const { return m_nodeDistribution; }
168 
173  virtual const int* getNumSubdivisionsPerDim() const { return m_NX; }
174 
179  virtual double getLocalCoordinate(index_t index, int dim) const;
180 
185  virtual boost::python::tuple getGridParameters() const;
186 
191  virtual escript::Data randomFill(const escript::DataTypes::ShapeType& shape,
192  const escript::FunctionSpace& what, long seed, const boost::python::tuple& filter) const;
193 
198  virtual Assembler_ptr createAssembler(std::string type,
199  const DataMap& options) const;
200 
206  virtual void interpolateAcross(escript::Data& target,
207  const escript::Data& source) const;
208 
213  virtual bool probeInterpolationAcross(int, const escript::AbstractDomain&,
214  int) const;
215 
220  const double *getLength() const { return m_length; }
221 
222 protected:
223  virtual dim_t getNumNodes() const;
224  virtual dim_t getNumElements() const;
225  virtual dim_t getNumDOF() const;
226 #ifdef ESYS_MPI
227  virtual void balanceNeighbours(escript::Data& data, bool average) const;
228 #endif
229  virtual void assembleCoordinates(escript::Data& arg) const;
230  virtual void assembleGradient(escript::Data& out,
231  const escript::Data& in) const;
232  virtual void assembleIntegrate(std::vector<real_t>& integrals,
233  const escript::Data& arg) const;
234  virtual void assembleIntegrate(std::vector<cplx_t>& integrals,
235  const escript::Data& arg) const;
236  virtual void interpolateNodesOnElements(escript::Data& out,
237  const escript::Data& in,
238  bool reduced) const;
239  virtual void interpolateElementsOnNodes(escript::Data& out,
240  const escript::Data& in) const;
241  virtual dim_t getDofOfNode(dim_t node) const;
242  virtual void reduceElements(escript::Data& out, const escript::Data& in) const;
243 
244 private:
245  template<typename Scalar>
246  void gradient_order2(escript::Data&, const escript::Data&) const;
247  template<typename Scalar>
248  void gradient_order3(escript::Data&, const escript::Data&) const;
249  template<typename Scalar>
250  void gradient_order4(escript::Data&, const escript::Data&) const;
251  template<typename Scalar>
252  void gradient_order5(escript::Data&, const escript::Data&) const;
253  template<typename Scalar>
254  void gradient_order6(escript::Data&, const escript::Data&) const;
255  template<typename Scalar>
256  void gradient_order7(escript::Data&, const escript::Data&) const;
257  template<typename Scalar>
258  void gradient_order8(escript::Data&, const escript::Data&) const;
259  template<typename Scalar>
260  void gradient_order9(escript::Data&, const escript::Data&) const;
261  template<typename Scalar>
262  void gradient_order10(escript::Data&, const escript::Data&) const;
263 
264  template<typename Scalar>
265  void reduction_order2(const escript::Data&, escript::Data&) const;
266  template<typename Scalar>
267  void reduction_order3(const escript::Data&, escript::Data&) const;
268  template<typename Scalar>
269  void reduction_order4(const escript::Data&, escript::Data&) const;
270  template<typename Scalar>
271  void reduction_order5(const escript::Data&, escript::Data&) const;
272  template<typename Scalar>
273  void reduction_order6(const escript::Data&, escript::Data&) const;
274  template<typename Scalar>
275  void reduction_order7(const escript::Data&, escript::Data&) const;
276  template<typename Scalar>
277  void reduction_order8(const escript::Data&, escript::Data&) const;
278  template<typename Scalar>
279  void reduction_order9(const escript::Data&, escript::Data&) const;
280  template<typename Scalar>
281  void reduction_order10(const escript::Data&, escript::Data&) const;
282 
283  template<typename Scalar>
284  void integral_order2(std::vector<Scalar>&, const escript::Data&) const;
285  template<typename Scalar>
286  void integral_order3(std::vector<Scalar>&, const escript::Data&) const;
287  template<typename Scalar>
288  void integral_order4(std::vector<Scalar>&, const escript::Data&) const;
289  template<typename Scalar>
290  void integral_order5(std::vector<Scalar>&, const escript::Data&) const;
291  template<typename Scalar>
292  void integral_order6(std::vector<Scalar>&, const escript::Data&) const;
293  template<typename Scalar>
294  void integral_order7(std::vector<Scalar>&, const escript::Data&) const;
295  template<typename Scalar>
296  void integral_order8(std::vector<Scalar>&, const escript::Data&) const;
297  template<typename Scalar>
298  void integral_order9(std::vector<Scalar>&, const escript::Data&) const;
299  template<typename Scalar>
300  void integral_order10(std::vector<Scalar>&, const escript::Data&) const;
301 
302  template<typename Scalar>
303  void assembleIntegrateWorker(std::vector<Scalar>& integrals,
304  const escript::Data& arg) const;
305 
306  template<typename Scalar>
307  void interpolateNodesOnElementsWorker(escript::Data& out,
308  const escript::Data& in,
309  bool reduced) const;
310 
311  template<typename Scalar>
312  void interpolateElementsOnNodesWorker(escript::Data& out,
313  const escript::Data& in) const;
314 
315 #ifdef ESYS_MPI
316  template<typename Scalar>
317  void balanceNeighboursWorker(escript::Data& data, bool average) const;
318 
319  /* \brief
320  Sums the values across MPI overlaps
321  */
322  template<typename Scalar>
323  void shareCorners(escript::Data& out, int rx, int ry) const;
324  /* \brief
325  Sums the values across MPI overlaps
326  */
327  template<typename Scalar>
328  void shareSides(escript::Data& out, int rx, int ry) const;
329 
330  /* \brief
331  Sums the values across MPI overlaps
332  */
333  template<typename Scalar>
334  void shareVertical(escript::Data& out, int rx, int ry) const;
335 #endif
336 
337  /* \brief
338  interpolates the non-corner point values of an element
339  from the corner values
340  */
341  void interpolateFromCorners(escript::Data& out) const;
342 
343  void populateSampleIds();
344 
345  template<typename ValueType>
346  void readBinaryGridImpl(escript::Data& out, const std::string& filename,
347  const ReaderParameters& params) const;
348 
349 #ifdef ESYS_HAVE_BOOST_IO
350  template<typename ValueType>
351  void readBinaryGridZippedImpl(escript::Data& out,
352  const std::string& filename, const ReaderParameters& params) const;
353 #endif
354 
355  template<typename ValueType>
356  void writeBinaryGridImpl(const escript::Data& in,
357  const std::string& filename, int byteOrder) const;
358 
359  dim_t findNode(const double *coords) const;
360 
362  dim_t m_gNE[2];
363 
365  double m_origin[2];
366 
368  double m_length[2];
369 
371  double m_dx[2];
372 
374  int m_NX[2];
375 
377  dim_t m_NE[2];
378 
380  dim_t m_NN[2];
381 
383  dim_t m_offset[2];
384 
386  dim_t m_faceCount[4];
387 
389  IndexVector m_dofId;
390  IndexVector m_nodeId;
391  IndexVector m_elementId;
392 
393  // vector with first node id on each rank
394  IndexVector m_nodeDistribution;
395 
396 #ifdef USE_RIPLEY
397  mutable RipleyCoupler *coupler;
398 #endif
399 
400  friend class DefaultAssembler2D;
401  friend class WaveAssembler2D;
402 };
403 
405 inline dim_t Rectangle::getDofOfNode(dim_t node) const
406 {
407  return m_nodeId[node];
408 }
409 
411 {
412  return (m_gNE[0]*m_order+1)*(m_gNE[1]*m_order+1);
413 }
414 
415 inline double Rectangle::getLocalCoordinate(index_t index, int dim) const
416 {
417  ESYS_ASSERT(dim>=0 && dim<2, "'dim' out of bounds");
418  ESYS_ASSERT(index>=0 && index<m_NN[dim], "'index' out of bounds");
419  return m_origin[dim] //origin
420  + m_dx[dim]*(m_offset[dim] + index/m_order //elements
421  + point_locations[m_order-2][index%m_order]); //quads
422 }
423 
424 inline boost::python::tuple Rectangle::getGridParameters() const
425 {
426  return boost::python::make_tuple(
427  boost::python::make_tuple(m_origin[0], m_origin[1]),
428  boost::python::make_tuple(m_dx[0], m_dx[1]),
429  boost::python::make_tuple(m_gNE[0], m_gNE[1]));
430 }
431 
432 //protected
433 inline dim_t Rectangle::getNumDOF() const
434 {
435  return getNumNodes();
436 }
437 
438 //protected
439 inline dim_t Rectangle::getNumNodes() const
440 {
441  return m_NN[0] * m_NN[1];
442 }
443 
444 //protected
445 inline dim_t Rectangle::getNumElements() const
446 {
447  return m_NE[0]*m_NE[1];
448 }
449 
450 } // end of namespace speckley
451 
452 #endif // __SPECKLEY_RECTANGLE_H__
453 
speckley::TagMap
std::map< std::string, int > TagMap
Definition: Speckley.h:57
speckley::readNcGrid
escript::Data readNcGrid(std::string filename, std::string varname, escript::FunctionSpace fs, const object &pyShape, double fill, const object &pyFirst, const object &pyNum, const object &pyMultiplier, const object &pyReverse)
Definition: speckleycpp.cpp:113
speckley::SpeckleyDomain::m_order
int m_order
element order (will be m_order + 1 quad points in each axis)
Definition: speckley/src/SpeckleyDomain.h:752
speckley::readBinaryGridFromZipped
escript::Data readBinaryGridFromZipped(std::string filename, escript::FunctionSpace fs, const object &pyShape, double fill, int byteOrder, int dataType, const object &pyFirst, const object &pyNum, const object &pyMultiplier, const object &pyReverse)
Definition: speckleycpp.cpp:84
speckley::Rectangle::getDofOfNode
virtual dim_t getDofOfNode(dim_t node) const
Definition: speckley/src/Rectangle.h:416
speckley::Rectangle::getNumDOF
virtual dim_t getNumDOF() const
returns the number of degrees of freedom per MPI rank
Definition: speckley/src/Rectangle.h:444
escript::FunctionSpace
Definition: FunctionSpace.h:45
speckley::DefaultAssembler2D
Definition: speckley/src/DefaultAssembler2D.h:35
speckley::probeInterpolationAcross
bool probeInterpolationAcross(int fsType_source, const escript::AbstractDomain &domain, int fsType_target, int dim)
Definition: CrossDomainCoupler.cpp:30
speckley
Definition: AbstractAssembler.cpp:17
speckley::Rectangle::getNumNodes
virtual dim_t getNumNodes() const
returns the number of nodes per MPI rank
Definition: speckley/src/Rectangle.h:450
speckley::readBinaryGrid
escript::Data readBinaryGrid(std::string filename, escript::FunctionSpace fs, const object &pyShape, double fill, int byteOrder, int dataType, const object &pyFirst, const object &pyNum, const object &pyMultiplier, const object &pyReverse)
Definition: speckleycpp.cpp:59
escript::Data
Data represents a collection of datapoints.
Definition: Data.h:62
speckley::Rectangle::m_NN
dim_t m_NN[2]
number of nodes for this rank in each dimension
Definition: speckley/src/Rectangle.h:403
escript::DataTypes::dim_t
index_t dim_t
Definition: DataTypes.h:87
escript::DataTypes::ShapeType
std::vector< int > ShapeType
The shape of a single datapoint.
Definition: DataTypes.h:65
speckley::Rectangle::m_gNE
dim_t m_gNE[2]
total number of elements in each dimension
Definition: speckley/src/Rectangle.h:385
speckley::WaveAssembler2D
Definition: speckley/src/WaveAssembler2D.h:35
speckley::Rectangle::getLocalCoordinate
virtual double getLocalCoordinate(index_t index, int dim) const
returns the index'th coordinate value in given dimension for this rank
Definition: speckley/src/Rectangle.h:426
speckley::Rectangle::m_dx
double m_dx[2]
grid spacings / cell sizes of domain
Definition: speckley/src/Rectangle.h:394
speckley::Rectangle
Rectangle is the 2-dimensional implementation of a SpeckleyDomain.
Definition: speckley/src/Rectangle.h:43
speckley::RipleyCoupler
Definition: CrossDomainCoupler.h:39
speckley::Rectangle::getNumDataPointsGlobal
virtual dim_t getNumDataPointsGlobal() const
returns the number of data points summed across all MPI processes
Definition: speckley/src/Rectangle.h:421
escript::SubWorld_ptr
boost::shared_ptr< SubWorld > SubWorld_ptr
Definition: SubWorld.h:157
speckley::Rectangle::getNumElements
virtual dim_t getNumElements() const
returns the number of elements per MPI rank
Definition: speckley/src/Rectangle.h:456
escript::DataTypes::index_t
int index_t
type for array/matrix indices used both globally and on each rank
Definition: DataTypes.h:82
speckley::Rectangle::m_origin
double m_origin[2]
origin of domain
Definition: speckley/src/Rectangle.h:388
speckley::Rectangle::m_nodeId
IndexVector m_nodeId
Definition: speckley/src/Rectangle.h:413
speckley::Rectangle::getGridParameters
virtual boost::python::tuple getGridParameters() const
returns the tuple (origin, spacing, number_of_elements)
Definition: speckley/src/Rectangle.h:435
speckley::ReaderParameters
Structure that wraps parameters for the grid reading routines.
Definition: speckley/src/SpeckleyDomain.h:62
escript::AbstractDomain
Base class for all escript domains.
Definition: AbstractDomain.h:56
speckley::Rectangle::m_NE
dim_t m_NE[2]
number of elements for this rank in each dimension including shared
Definition: speckley/src/Rectangle.h:400
speckley::IndexVector
std::vector< index_t > IndexVector
Definition: Speckley.h:55
Speckley_DLL_API
#define Speckley_DLL_API
Definition: speckley/src/system_dep.h:21
speckley::Rectangle::m_offset
dim_t m_offset[2]
first node on this rank is at (offset0,offset1) in global mesh
Definition: speckley/src/Rectangle.h:406
speckley::DataMap
std::map< std::string, escript::Data > DataMap
Definition: speckley/src/domainhelpers.h:35
ESYS_ASSERT
#define ESYS_ASSERT(a, b)
EsysAssert is a MACRO that will throw an exception if the boolean condition specified is false.
Definition: Assert.h:77
speckley::point_locations
const double point_locations[][11]
Definition: Speckley.h:82