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 #ifdef USE_BOOSTIO
92 
94  virtual void readBinaryGridFromZipped(escript::Data& out,
95  std::string filename, const ReaderParameters& params) const;
96 #endif
97 
100  virtual void writeBinaryGrid(const escript::Data& in,
101  std::string filename,
102  int byteOrder, int dataType) const;
103 
109  const dim_t* borrowSampleReferenceIDs(int fsType) const;
110 
115  virtual bool ownSample(int fs_code, index_t id) const;
116 
123  virtual void setToNormal(escript::Data& out) const;
124 
130  virtual void setToSize(escript::Data& out) const;
131 
136  virtual dim_t getNumDataPointsGlobal() const;
137 
143  virtual void Print_Mesh_Info(const bool full=false) const;
144 
149  virtual const dim_t* getNumNodesPerDim() const { return m_NN; }
150 
155  virtual const dim_t* getNumElementsPerDim() const { return m_NE; }
156 
162  virtual const dim_t* getNumFacesPerBoundary() const { return m_faceCount; }
163 
168  virtual IndexVector getNodeDistribution() const { return m_nodeDistribution; }
169 
174  virtual const int* getNumSubdivisionsPerDim() const { return m_NX; }
175 
180  virtual double getLocalCoordinate(index_t index, int dim) const;
181 
186  virtual boost::python::tuple getGridParameters() const;
187 
192  virtual escript::Data randomFill(const escript::DataTypes::ShapeType& shape,
193  const escript::FunctionSpace& what, long seed, const boost::python::tuple& filter) const;
194 
199  virtual Assembler_ptr createAssembler(std::string type,
200  const DataMap& options) const;
201 
207  virtual void interpolateAcross(escript::Data& target,
208  const escript::Data& source) const;
209 
214  virtual bool probeInterpolationAcross(int, const escript::AbstractDomain&,
215  int) const;
216 
221  const double *getLength() const { return m_length; }
222 
223 protected:
224  virtual dim_t getNumNodes() const;
225  virtual dim_t getNumElements() const;
226  virtual dim_t getNumDOF() const;
227 #ifdef ESYS_MPI
228  virtual void balanceNeighbours(escript::Data& data, bool average) const;
229 #endif
230  virtual void assembleCoordinates(escript::Data& arg) const;
231  virtual void assembleGradient(escript::Data& out,
232  const escript::Data& in) const;
233  virtual void assembleIntegrate(DoubleVector& integrals,
234  const escript::Data& arg) const;
235  virtual void interpolateNodesOnElements(escript::Data& out,
236  const escript::Data& in,
237  bool reduced) const;
238  virtual void interpolateElementsOnNodes(escript::Data& out,
239  const escript::Data& in) const;
240  virtual dim_t getDofOfNode(dim_t node) const;
241  virtual void reduceElements(escript::Data& out, const escript::Data& in) const;
242 
243 private:
244  void gradient_order2(escript::Data&, const escript::Data&) const;
245  void gradient_order3(escript::Data&, const escript::Data&) const;
246  void gradient_order4(escript::Data&, const escript::Data&) const;
247  void gradient_order5(escript::Data&, const escript::Data&) const;
248  void gradient_order6(escript::Data&, const escript::Data&) const;
249  void gradient_order7(escript::Data&, const escript::Data&) const;
250  void gradient_order8(escript::Data&, const escript::Data&) const;
251  void gradient_order9(escript::Data&, const escript::Data&) const;
252  void gradient_order10(escript::Data&, const escript::Data&) const;
253 
254  void reduction_order2(const escript::Data&, escript::Data&) const;
255  void reduction_order3(const escript::Data&, escript::Data&) const;
256  void reduction_order4(const escript::Data&, escript::Data&) const;
257  void reduction_order5(const escript::Data&, escript::Data&) const;
258  void reduction_order6(const escript::Data&, escript::Data&) const;
259  void reduction_order7(const escript::Data&, escript::Data&) const;
260  void reduction_order8(const escript::Data&, escript::Data&) const;
261  void reduction_order9(const escript::Data&, escript::Data&) const;
262  void reduction_order10(const escript::Data&, escript::Data&) const;
263 
264  void integral_order2(std::vector<double>&, const escript::Data&) const;
265  void integral_order3(std::vector<double>&, const escript::Data&) const;
266  void integral_order4(std::vector<double>&, const escript::Data&) const;
267  void integral_order5(std::vector<double>&, const escript::Data&) const;
268  void integral_order6(std::vector<double>&, const escript::Data&) const;
269  void integral_order7(std::vector<double>&, const escript::Data&) const;
270  void integral_order8(std::vector<double>&, const escript::Data&) const;
271  void integral_order9(std::vector<double>&, const escript::Data&) const;
272  void integral_order10(std::vector<double>&, const escript::Data&) const;
273 #ifdef ESYS_MPI
274  /* \brief
275  Sums the values across MPI overlaps
276  */
277  void shareCorners(escript::Data& out, int rx, int ry) const;
278  /* \brief
279  Sums the values across MPI overlaps
280  */
281  void shareSides(escript::Data& out, int rx, int ry) const;
282 
283  /* \brief
284  Sums the values across MPI overlaps
285  */
286  void shareVertical(escript::Data& out, int rx, int ry) const;
287 #endif
288 
289  /* \brief
290  interpolates the non-corner point values of an element
291  from the corner values
292  */
293  void interpolateFromCorners(escript::Data& out) const;
294 
295  void populateSampleIds();
296  void addToMatrixAndRHS(escript::AbstractSystemMatrix* S, escript::Data& F,
297  const DoubleVector& EM_S, const DoubleVector& EM_F,
298  bool addS, bool addF, index_t firstNode, int nEq=1, int nComp=1) const;
299 
300  template<typename ValueType>
301  void readBinaryGridImpl(escript::Data& out, const std::string& filename,
302  const ReaderParameters& params) const;
303 
304  template<typename ValueType>
305  void readBinaryGridZippedImpl(escript::Data& out,
306  const std::string& filename, const ReaderParameters& params) const;
307 
308  template<typename ValueType>
309  void writeBinaryGridImpl(const escript::Data& in,
310  const std::string& filename, int byteOrder) const;
311 
312  dim_t findNode(const double *coords) const;
313 
315  dim_t m_gNE[2];
316 
318  double m_origin[2];
319 
321  double m_length[2];
322 
324  double m_dx[2];
325 
327  int m_NX[2];
328 
330  dim_t m_NE[2];
331 
333  dim_t m_NN[2];
334 
336  dim_t m_offset[2];
337 
339  dim_t m_faceCount[4];
340 
345 
346  // vector with first node id on each rank
348 
349 #ifdef USE_RIPLEY
350  mutable RipleyCoupler *coupler;
351 #endif
352 
353  friend class DefaultAssembler2D;
354  friend class WaveAssembler2D;
355 };
356 
359 {
360  return m_nodeId[node];
361 }
362 
364 {
365  return (m_gNE[0]*m_order+1)*(m_gNE[1]*m_order+1);
366 }
367 
368 inline double Rectangle::getLocalCoordinate(index_t index, int dim) const
369 {
370  EsysAssert((dim>=0 && dim<2), "'dim' out of bounds");
371  EsysAssert((index>=0 && index<m_NN[dim]), "'index' out of bounds");
372  return m_origin[dim] //origin
373  + m_dx[dim]*(m_offset[dim] + index/m_order //elements
374  + point_locations[m_order-2][index%m_order]); //quads
375 }
376 
377 inline boost::python::tuple Rectangle::getGridParameters() const
378 {
379  return boost::python::make_tuple(
380  boost::python::make_tuple(m_origin[0], m_origin[1]),
381  boost::python::make_tuple(m_dx[0], m_dx[1]),
382  boost::python::make_tuple(m_gNE[0], m_gNE[1]));
383 }
384 
385 //protected
387 {
388  return getNumNodes();
389 }
390 
391 //protected
393 {
394  return m_NN[0] * m_NN[1];
395 }
396 
397 //protected
399 {
400  return m_NE[0]*m_NE[1];
401 }
402 
403 } // end of namespace speckley
404 
405 #endif // __SPECKLEY_RECTANGLE_H__
406 
Definition: FunctionSpace.h:34
Definition: AbstractAssembler.cpp:22
SpeckleyDomain extends the AbstractContinuousDomain interface for the Speckley library and is the bas...
Definition: speckley/src/SpeckleyDomain.h:84
bool probeInterpolationAcross(int fsType_source, const escript::AbstractDomain &domain, int fsType_target, int dim)
Definition: CrossDomainCoupler.cpp:36
IndexVector m_elementId
Definition: speckley/src/Rectangle.h:344
virtual dim_t getNumDOF() const
returns the number of degrees of freedom per MPI rank
Definition: speckley/src/Rectangle.h:386
virtual const dim_t * getNumNodesPerDim() const
returns the number of nodes per MPI rank in each dimension
Definition: speckley/src/Rectangle.h:149
Definition: CrossDomainCoupler.h:27
std::map< std::string, escript::Data > DataMap
Definition: speckley/src/domainhelpers.h:24
std::vector< double > DoubleVector
Definition: Speckley.h:39
IndexVector m_nodeDistribution
Definition: speckley/src/Rectangle.h:347
virtual dim_t getDofOfNode(dim_t node) const
Definition: speckley/src/Rectangle.h:358
std::vector< int > ShapeType
The shape of a single datapoint.
Definition: DataTypes.h:38
IndexVector m_dofId
vector of sample reference identifiers
Definition: speckley/src/Rectangle.h:342
#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
Rectangle is the 2-dimensional implementation of a SpeckleyDomain.
Definition: speckley/src/Rectangle.h:32
virtual const int * getNumSubdivisionsPerDim() const
returns the number of spatial subdivisions in each dimension
Definition: speckley/src/Rectangle.h:174
virtual IndexVector getNodeDistribution() const
returns the node distribution vector
Definition: speckley/src/Rectangle.h:168
boost::shared_ptr< SubWorld > SubWorld_ptr
Definition: SubWorld.h:142
virtual boost::python::tuple getGridParameters() const
returns the tuple (origin, spacing, number_of_elements)
Definition: speckley/src/Rectangle.h:377
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:116
Data represents a collection of datapoints.
Definition: Data.h:68
std::vector< index_t > IndexVector
Definition: Speckley.h:38
#define EsysAssert(AssertTest, AssertMessage)
EsysAssert is a MACRO that will throw an exception if the boolean condition specified is false...
Definition: EsysAssert.h:96
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:64
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:162
int index_t
Definition: types.h:24
std::map< std::string, int > TagMap
Definition: Speckley.h:41
virtual dim_t getNumDataPointsGlobal() const
returns the number of data points summed across all MPI processes
Definition: speckley/src/Rectangle.h:363
virtual dim_t getNumElements() const
returns the number of elements per MPI rank
Definition: speckley/src/Rectangle.h:398
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:368
index_t dim_t
Definition: types.h:27
Base class for escript system matrices.
Definition: AbstractSystemMatrix.h:37
IndexVector m_nodeId
Definition: speckley/src/Rectangle.h:343
const double point_locations[][11]
Definition: Speckley.h:56
virtual const dim_t * getNumElementsPerDim() const
returns the number of elements per MPI rank in each dimension
Definition: speckley/src/Rectangle.h:155
Base class for all escript domains.
Definition: AbstractDomain.h:45
#define S(_J_, _I_)
Definition: ShapeFunctions.cpp:121
virtual dim_t getNumNodes() const
returns the number of nodes per MPI rank
Definition: speckley/src/Rectangle.h:392
const double * getLength() const
returns the lengths of the domain
Definition: speckley/src/Rectangle.h:221