escript  Revision_
speckley/src/Rectangle.h
Go to the documentation of this file.
1 
2 /*****************************************************************************
3 *
4 * Copyright (c) 2003-2016 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 
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(DoubleVector& integrals,
233  const escript::Data& arg) const;
234  virtual void interpolateNodesOnElements(escript::Data& out,
235  const escript::Data& in,
236  bool reduced) const;
237  virtual void interpolateElementsOnNodes(escript::Data& out,
238  const escript::Data& in) const;
239  virtual dim_t getDofOfNode(dim_t node) const;
240  virtual void reduceElements(escript::Data& out, const escript::Data& in) const;
241 
242 private:
243  void gradient_order2(escript::Data&, const escript::Data&) const;
244  void gradient_order3(escript::Data&, const escript::Data&) const;
245  void gradient_order4(escript::Data&, const escript::Data&) const;
246  void gradient_order5(escript::Data&, const escript::Data&) const;
247  void gradient_order6(escript::Data&, const escript::Data&) const;
248  void gradient_order7(escript::Data&, const escript::Data&) const;
249  void gradient_order8(escript::Data&, const escript::Data&) const;
250  void gradient_order9(escript::Data&, const escript::Data&) const;
251  void gradient_order10(escript::Data&, const escript::Data&) const;
252 
253  void reduction_order2(const escript::Data&, escript::Data&) const;
254  void reduction_order3(const escript::Data&, escript::Data&) const;
255  void reduction_order4(const escript::Data&, escript::Data&) const;
256  void reduction_order5(const escript::Data&, escript::Data&) const;
257  void reduction_order6(const escript::Data&, escript::Data&) const;
258  void reduction_order7(const escript::Data&, escript::Data&) const;
259  void reduction_order8(const escript::Data&, escript::Data&) const;
260  void reduction_order9(const escript::Data&, escript::Data&) const;
261  void reduction_order10(const escript::Data&, escript::Data&) const;
262 
263  void integral_order2(std::vector<double>&, const escript::Data&) const;
264  void integral_order3(std::vector<double>&, const escript::Data&) const;
265  void integral_order4(std::vector<double>&, const escript::Data&) const;
266  void integral_order5(std::vector<double>&, const escript::Data&) const;
267  void integral_order6(std::vector<double>&, const escript::Data&) const;
268  void integral_order7(std::vector<double>&, const escript::Data&) const;
269  void integral_order8(std::vector<double>&, const escript::Data&) const;
270  void integral_order9(std::vector<double>&, const escript::Data&) const;
271  void integral_order10(std::vector<double>&, const escript::Data&) const;
272 #ifdef ESYS_MPI
273  /* \brief
274  Sums the values across MPI overlaps
275  */
276  void shareCorners(escript::Data& out, int rx, int ry) const;
277  /* \brief
278  Sums the values across MPI overlaps
279  */
280  void shareSides(escript::Data& out, int rx, int ry) const;
281 
282  /* \brief
283  Sums the values across MPI overlaps
284  */
285  void shareVertical(escript::Data& out, int rx, int ry) const;
286 #endif
287 
288  /* \brief
289  interpolates the non-corner point values of an element
290  from the corner values
291  */
292  void interpolateFromCorners(escript::Data& out) const;
293 
294  void populateSampleIds();
295  void addToMatrixAndRHS(escript::AbstractSystemMatrix* S, escript::Data& F,
296  const DoubleVector& EM_S, const DoubleVector& EM_F,
297  bool addS, bool addF, index_t firstNode, int nEq=1, int nComp=1) const;
298 
299  template<typename ValueType>
300  void readBinaryGridImpl(escript::Data& out, const std::string& filename,
301  const ReaderParameters& params) const;
302 
303 #ifdef ESYS_HAVE_BOOST_IO
304  template<typename ValueType>
305  void readBinaryGridZippedImpl(escript::Data& out,
306  const std::string& filename, const ReaderParameters& params) const;
307 #endif
308 
309  template<typename ValueType>
310  void writeBinaryGridImpl(const escript::Data& in,
311  const std::string& filename, int byteOrder) const;
312 
313  dim_t findNode(const double *coords) const;
314 
316  dim_t m_gNE[2];
317 
319  double m_origin[2];
320 
322  double m_length[2];
323 
325  double m_dx[2];
326 
328  int m_NX[2];
329 
331  dim_t m_NE[2];
332 
334  dim_t m_NN[2];
335 
337  dim_t m_offset[2];
338 
340  dim_t m_faceCount[4];
341 
346 
347  // vector with first node id on each rank
349 
350 #ifdef USE_RIPLEY
351  mutable RipleyCoupler *coupler;
352 #endif
353 
354  friend class DefaultAssembler2D;
355  friend class WaveAssembler2D;
356 };
357 
360 {
361  return m_nodeId[node];
362 }
363 
365 {
366  return (m_gNE[0]*m_order+1)*(m_gNE[1]*m_order+1);
367 }
368 
369 inline double Rectangle::getLocalCoordinate(index_t index, int dim) const
370 {
371  ESYS_ASSERT(dim>=0 && dim<2, "'dim' out of bounds");
372  ESYS_ASSERT(index>=0 && index<m_NN[dim], "'index' out of bounds");
373  return m_origin[dim] //origin
374  + m_dx[dim]*(m_offset[dim] + index/m_order //elements
375  + point_locations[m_order-2][index%m_order]); //quads
376 }
377 
378 inline boost::python::tuple Rectangle::getGridParameters() const
379 {
380  return boost::python::make_tuple(
381  boost::python::make_tuple(m_origin[0], m_origin[1]),
382  boost::python::make_tuple(m_dx[0], m_dx[1]),
383  boost::python::make_tuple(m_gNE[0], m_gNE[1]));
384 }
385 
386 //protected
388 {
389  return getNumNodes();
390 }
391 
392 //protected
394 {
395  return m_NN[0] * m_NN[1];
396 }
397 
398 //protected
400 {
401  return m_NE[0]*m_NE[1];
402 }
403 
404 } // end of namespace speckley
405 
406 #endif // __SPECKLEY_RECTANGLE_H__
407 
Definition: FunctionSpace.h:34
Definition: AbstractAssembler.cpp:18
SpeckleyDomain extends the AbstractContinuousDomain interface for the Speckley library and is the bas...
Definition: speckley/src/SpeckleyDomain.h:84
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:85
bool probeInterpolationAcross(int fsType_source, const escript::AbstractDomain &domain, int fsType_target, int dim)
Definition: CrossDomainCoupler.cpp:31
IndexVector m_elementId
Definition: speckley/src/Rectangle.h:345
std::vector< real_t > DoubleVector
Definition: Speckley.h:43
virtual const dim_t * getNumNodesPerDim() const
returns the number of nodes per MPI rank in each dimension
Definition: speckley/src/Rectangle.h:148
virtual dim_t getNumDataPointsGlobal() const
returns the number of data points summed across all MPI processes
Definition: speckley/src/Rectangle.h:364
virtual const int * getNumSubdivisionsPerDim() const
returns the number of spatial subdivisions in each dimension
Definition: speckley/src/Rectangle.h:173
Definition: CrossDomainCoupler.h:28
std::map< std::string, escript::Data > DataMap
Definition: speckley/src/domainhelpers.h:24
IndexVector m_nodeDistribution
Definition: speckley/src/Rectangle.h:348
virtual boost::python::tuple getGridParameters() const
returns the tuple (origin, spacing, number_of_elements)
Definition: speckley/src/Rectangle.h:378
std::vector< int > ShapeType
The shape of a single datapoint.
Definition: DataTypes.h:42
IndexVector m_dofId
vector of sample reference identifiers
Definition: speckley/src/Rectangle.h:343
virtual IndexVector getNodeDistribution() const
returns the node distribution vector
Definition: speckley/src/Rectangle.h:167
#define Speckley_DLL_API
Definition: speckley/src/system_dep.h:22
Definition: speckley/src/WaveAssembler2D.h:24
Structure that wraps parameters for the grid reading routines.
Definition: speckley/src/SpeckleyDomain.h:51
virtual const dim_t * getNumElementsPerDim() const
returns the number of elements per MPI rank in each dimension
Definition: speckley/src/Rectangle.h:154
virtual dim_t getNumNodes() const
returns the number of nodes per MPI rank
Definition: speckley/src/Rectangle.h:393
Rectangle is the 2-dimensional implementation of a SpeckleyDomain.
Definition: speckley/src/Rectangle.h:32
int index_t
type for array/matrix indices used both globally and on each rank
Definition: DataTypes.h:59
boost::shared_ptr< SubWorld > SubWorld_ptr
Definition: SubWorld.h:146
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:114
Data represents a collection of datapoints.
Definition: Data.h:63
virtual dim_t getNumElements() const
returns the number of elements per MPI rank
Definition: speckley/src/Rectangle.h:399
virtual const dim_t * getNumFacesPerBoundary() const
returns the number of face elements in the order (left,right,bottom,top) on current MPI rank ...
Definition: speckley/src/Rectangle.h:161
virtual dim_t getDofOfNode(dim_t node) const
Definition: speckley/src/Rectangle.h:359
std::vector< index_t > IndexVector
Definition: Speckley.h:42
Definition: speckley/src/DefaultAssembler2D.h:24
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:60
std::map< std::string, int > TagMap
Definition: Speckley.h:44
virtual dim_t getNumDOF() const
returns the number of degrees of freedom per MPI rank
Definition: speckley/src/Rectangle.h:387
Base class for escript system matrices.
Definition: AbstractSystemMatrix.h:42
IndexVector m_nodeId
Definition: speckley/src/Rectangle.h:344
const double point_locations[][11]
Definition: Speckley.h:59
const double * getLength() const
returns the lengths of the domain
Definition: speckley/src/Rectangle.h:220
Base class for all escript domains.
Definition: AbstractDomain.h:45
#define ESYS_ASSERT(a, b)
EsysAssert is a MACRO that will throw an exception if the boolean condition specified is false...
Definition: Assert.h:78
#define S(_J_, _I_)
Definition: ShapeFunctions.cpp:121
index_t dim_t
Definition: DataTypes.h:64
virtual double getLocalCoordinate(index_t index, int dim) const
returns the index&#39;th coordinate value in given dimension for this rank
Definition: speckley/src/Rectangle.h:369