escript  Revision_
ripley/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 __RIPLEY_RECTANGLE_H__
18 #define __RIPLEY_RECTANGLE_H__
19 
20 #include <ripley/RipleyDomain.h>
21 
22 namespace ripley {
23 
29 {
30  template<class Scalar> friend class DefaultAssembler2D;
31  friend class WaveAssembler2D;
32  friend class LameAssembler2D;
33 public:
34 
42  Rectangle(dim_t n0, dim_t n1, double x0, double y0, double x1, double y1,
43  int d0=-1, int d1=-1,
44  const std::vector<double>& points = std::vector<double>(),
45  const std::vector<int>& tags = std::vector<int>(),
46  const TagMap& tagnamestonums = TagMap(),
48  );
49 
54  ~Rectangle();
55 
60  virtual std::string getDescription() const;
61 
65  virtual bool operator==(const escript::AbstractDomain& other) const;
66 
72  virtual void write(const std::string& filename) const;
73 
79  void dump(const std::string& filename) const;
80 
83  virtual void readNcGrid(escript::Data& out, std::string filename,
84  std::string varname, const ReaderParameters& params) const;
85 
88  virtual void readBinaryGrid(escript::Data& out, std::string filename,
89  const ReaderParameters& params) const;
90 
93  virtual void readBinaryGridFromZipped(escript::Data& out, std::string filename,
94  const ReaderParameters& params) const;
95 
98  virtual void writeBinaryGrid(const escript::Data& in,
99  std::string filename,
100  int byteOrder, int dataType) const;
101 
107  const dim_t* borrowSampleReferenceIDs(int fsType) const;
108 
113  virtual bool ownSample(int fsType, index_t id) const;
114 
121  virtual void setToNormal(escript::Data& out) const;
122 
128  virtual void setToSize(escript::Data& out) const;
129 
134  virtual dim_t getNumDataPointsGlobal() const;
135 
141  virtual void Print_Mesh_Info(const bool full=false) const;
142 
147  virtual const dim_t* getNumNodesPerDim() const { return m_NN; }
148 
153  virtual const dim_t* getNumElementsPerDim() const { return m_NE; }
154 
160  virtual const dim_t* getNumFacesPerBoundary() const { return m_faceCount; }
161 
166  virtual IndexVector getNodeDistribution() const { return m_nodeDistribution; }
167 
172  virtual const int* getNumSubdivisionsPerDim() const { return m_NX; }
173 
178  virtual double getLocalCoordinate(index_t index, int dim) const;
179 
184  virtual boost::python::tuple getGridParameters() const;
185 
190  virtual escript::Data randomFill(const escript::DataTypes::ShapeType& shape,
191  const escript::FunctionSpace& what, long seed,
192  const boost::python::tuple& filter) const;
193 
198  virtual Assembler_ptr createAssembler(std::string type,
199  const DataMap& options) const;
200 
205  const double *getLength() const { return m_length; }
206 
211  const double *getElementLength() const { return m_dx; }
212 
218  virtual RankVector getOwnerVector(int fsType) const;
219 
220 protected:
221  virtual dim_t getNumNodes() const;
222  virtual dim_t getNumElements() const;
223  virtual dim_t getNumFaceElements() const;
224  virtual dim_t getNumDOF() const;
225  virtual dim_t getNumDOFInAxis(unsigned axis) const;
226  virtual index_t getFirstInDim(unsigned axis) const;
227 
228  virtual IndexVector getDiagonalIndices(bool upperOnly) const;
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 std::vector<IndexVector> getConnections(bool includeShared=false) const;
237 
238 #ifdef ESYS_HAVE_TRILINOS
239  virtual esys_trilinos::const_TrilinosGraph_ptr getTrilinosGraph() const;
240 #endif
241 
242 #ifdef ESYS_HAVE_PASO
243  virtual paso::SystemMatrixPattern_ptr getPasoMatrixPattern(
244  bool reducedRowOrder, bool reducedColOrder) const;
245 #endif
246  virtual void interpolateNodesOnElements(escript::Data& out,
247  const escript::Data& in, bool reduced) const;
248  virtual void interpolateNodesOnFaces(escript::Data& out,
249  const escript::Data& in,
250  bool reduced) const;
251 
252  virtual void nodesToDOF(escript::Data& out, const escript::Data& in) const;
253  virtual dim_t getDofOfNode(dim_t node) const;
254 
255  virtual void populateSampleIds();
256  virtual void populateDofMap();
257 
258  template<typename Scalar>
259  void assembleGradientImpl(escript::Data& out,
260  const escript::Data& in) const;
261 
262  template<typename Scalar>
263  void addToMatrixAndRHS(escript::AbstractSystemMatrix* S, escript::Data& F,
264  const std::vector<Scalar>& EM_S, const std::vector<Scalar>& EM_F,
265  bool addS, bool addF, index_t firstNode, int nEq=1, int nComp=1) const;
266 
267  template<typename ValueType>
268  void readBinaryGridImpl(escript::Data& out, const std::string& filename,
269  const ReaderParameters& params) const;
270 
271 #ifdef ESYS_HAVE_BOOST_IO
272  template<typename ValueType>
273  void readBinaryGridZippedImpl(escript::Data& out,
274  const std::string& filename, const ReaderParameters& params) const;
275 #endif
276 
277  template<typename ValueType>
278  void writeBinaryGridImpl(const escript::Data& in,
279  const std::string& filename, int byteOrder) const;
280 
281  virtual dim_t findNode(const double *coords) const;
282 
283 
284  escript::Data randomFillWorker(const escript::DataTypes::ShapeType& shape,
285  long seed, const boost::python::tuple& filter) const;
286 
288  dim_t m_gNE[2];
289 
291  double m_origin[2];
292 
294  double m_length[2];
295 
297  double m_dx[2];
298 
300  int m_NX[2];
301 
303  dim_t m_NE[2];
304 
306  dim_t m_ownNE[2];
307 
309  dim_t m_NN[2];
310 
312  dim_t m_offset[2];
313 
315  dim_t m_faceCount[4];
316 
320 
326 
327  // vector with first node id on each rank
329 
330  // vector that maps each node to a DOF index (used for the coupler)
332 
333 #ifdef ESYS_HAVE_PASO
334  // the Paso System Matrix pattern
335  mutable paso::SystemMatrixPattern_ptr m_pattern;
336 #endif
337 
338 #ifdef ESYS_HAVE_TRILINOS
339  mutable esys_trilinos::const_TrilinosGraph_ptr m_graph;
341 #endif
342 private:
343  template<typename Scalar>
344  void assembleIntegrateImpl(std::vector<Scalar>& integrals, const escript::Data& arg) const;
345 
346  template <typename S>
347  void interpolateNodesOnElementsWorker(escript::Data& out,
348  const escript::Data& in, bool reduced, S sentinel) const;
349  template <typename S>
350  void interpolateNodesOnFacesWorker(escript::Data& out,
351  const escript::Data& in,
352  bool reduced, S sentinel) const;
353 };
354 
357 {
358  return m_dofMap[node];
359 }
360 
362 {
363  return (m_gNE[0]+1)*(m_gNE[1]+1);
364 }
365 
366 inline double Rectangle::getLocalCoordinate(index_t index, int dim) const
367 {
368  ESYS_ASSERT(dim>=0 && dim<2, "'dim' out of bounds");
369  ESYS_ASSERT(index>=0 && index<m_NN[dim], "'index' out of bounds");
370  return m_origin[dim]+m_dx[dim]*(m_offset[dim]+index);
371 }
372 
373 inline boost::python::tuple Rectangle::getGridParameters() const
374 {
375  return boost::python::make_tuple(
376  boost::python::make_tuple(m_origin[0], m_origin[1]),
377  boost::python::make_tuple(m_dx[0], m_dx[1]),
378  boost::python::make_tuple(m_gNE[0], m_gNE[1]));
379 }
380 
381 //protected
383 {
384  return (m_gNE[0]+1)/m_NX[0]*(m_gNE[1]+1)/m_NX[1];
385 }
386 
387 //protected
388 inline dim_t Rectangle::getNumDOFInAxis(unsigned axis) const
389 {
390  ESYS_ASSERT(axis < m_numDim, "Invalid axis");
391  return (m_gNE[axis]+1)/m_NX[axis];
392 }
393 
394 //protected
396 {
397  return m_NN[0]*m_NN[1];
398 }
399 
400 //protected
402 {
403  return m_NE[0]*m_NE[1];
404 }
405 
406 //protected
408 {
409  return m_faceCount[0] + m_faceCount[1] + m_faceCount[2] + m_faceCount[3];
410 }
411 
412 //protected
413 inline index_t Rectangle::getFirstInDim(unsigned axis) const
414 {
415  return m_offset[axis] == 0 ? 0 : 1;
416 }
417 
418 } // end of namespace ripley
419 
420 #endif // __RIPLEY_RECTANGLE_H__
421 
virtual dim_t getNumDOF() const
returns the number of degrees of freedom per MPI rank
Definition: ripley/src/Rectangle.h:382
Definition: FunctionSpace.h:34
virtual dim_t getNumDataPointsGlobal() const
returns the number of data points summed across all MPI processes
Definition: ripley/src/Rectangle.h:361
virtual dim_t getNumNodes() const
returns the number of nodes per MPI rank
Definition: ripley/src/Rectangle.h:395
const double * getLength() const
returns the lengths of the domain
Definition: ripley/src/Rectangle.h:205
std::vector< int > RankVector
Definition: Ripley.h:45
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: ripleycpp.cpp:116
IndexVector m_elementId
Definition: ripley/src/Rectangle.h:324
IndexVector m_nodeId
Definition: ripley/src/Rectangle.h:323
virtual const dim_t * getNumFacesPerBoundary() const
returns the number of face elements in the order (left,right,bottom,top) on current MPI rank ...
Definition: ripley/src/Rectangle.h:160
Definition: ripley/src/WaveAssembler2D.h:24
Definition: LameAssembler2D.h:24
virtual dim_t getNumElements() const
returns the number of elements per MPI rank
Definition: ripley/src/Rectangle.h:401
IndexVector m_dofId
vector of sample reference identifiers
Definition: ripley/src/Rectangle.h:322
virtual dim_t getNumFaceElements() const
returns the number of face elements on current MPI rank
Definition: ripley/src/Rectangle.h:407
Definition: ripley/src/DefaultAssembler2D.h:24
std::vector< int > ShapeType
The shape of a single datapoint.
Definition: DataTypes.h:42
virtual double getLocalCoordinate(index_t index, int dim) const
returns the index&#39;th coordinate value in given dimension for this rank
Definition: ripley/src/Rectangle.h:366
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: ripleycpp.cpp:62
boost::shared_ptr< SystemMatrixPattern > SystemMatrixPattern_ptr
Definition: SystemMatrixPattern.h:39
IndexVector m_nodeDistribution
Definition: ripley/src/Rectangle.h:328
std::map< std::string, int > TagMap
Definition: Ripley.h:46
virtual boost::python::tuple getGridParameters() const
returns the tuple (origin, spacing, number_of_elements)
Definition: ripley/src/Rectangle.h:373
int index_t
type for array/matrix indices used both globally and on each rank
Definition: DataTypes.h:59
Rectangle is the 2-dimensional implementation of a RipleyDomain.
Definition: ripley/src/Rectangle.h:28
std::vector< index_t > IndexVector
Definition: Ripley.h:43
std::map< std::string, escript::Data > DataMap
Definition: ripley/src/domainhelpers.h:24
virtual const dim_t * getNumElementsPerDim() const
returns the number of elements per MPI rank in each dimension
Definition: ripley/src/Rectangle.h:153
boost::shared_ptr< SubWorld > SubWorld_ptr
Definition: SubWorld.h:146
Structure that wraps parameters for the grid reading routines.
Definition: ripley/src/RipleyDomain.h:68
virtual const int * getNumSubdivisionsPerDim() const
returns the number of spatial subdivisions in each dimension
Definition: ripley/src/Rectangle.h:172
virtual const dim_t * getNumNodesPerDim() const
returns the number of nodes per MPI rank in each dimension
Definition: ripley/src/Rectangle.h:147
Data represents a collection of datapoints.
Definition: Data.h:63
IndexVector m_faceId
Definition: ripley/src/Rectangle.h:325
RipleyDomain extends the AbstractContinuousDomain interface for the Ripley library and is the base cl...
Definition: ripley/src/RipleyDomain.h:101
IndexVector m_faceOffset
Definition: ripley/src/Rectangle.h:319
IndexVector m_dofMap
Definition: ripley/src/Rectangle.h:331
const double * getElementLength() const
returns the lengths of an element
Definition: ripley/src/Rectangle.h:211
virtual index_t getFirstInDim(unsigned axis) const
Definition: ripley/src/Rectangle.h:413
virtual dim_t getNumDOFInAxis(unsigned axis) const
Definition: ripley/src/Rectangle.h:388
virtual dim_t getDofOfNode(dim_t node) const
Definition: ripley/src/Rectangle.h:356
Base class for escript system matrices.
Definition: AbstractSystemMatrix.h:42
Definition: ripley/src/AbstractAssembler.h:25
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: ripleycpp.cpp:87
Base class for all escript domains.
Definition: AbstractDomain.h:45
virtual IndexVector getNodeDistribution() const
returns the node distribution vector
Definition: ripley/src/Rectangle.h:166
#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 RIPLEY_DLL_API
Definition: ripley/src/system_dep.h:20
#define S(_J_, _I_)
Definition: ShapeFunctions.cpp:121
index_t dim_t
Definition: DataTypes.h:64