escript  Revision_
ripley/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 __RIPLEY_RECTANGLE_H__
18 #define __RIPLEY_RECTANGLE_H__
19 
20 #include <paso/Coupler.h>
21 #include <ripley/RipleyDomain.h>
22 
23 namespace ripley {
24 
30 {
31  friend class DefaultAssembler2D;
32  friend class WaveAssembler2D;
33  friend class LameAssembler2D;
34 public:
35 
43  Rectangle(dim_t n0, dim_t n1, double x0, double y0, double x1, double y1,
44  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, std::string filename,
95  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 fsType, 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,
194  const boost::python::tuple& filter) const;
195 
200  virtual Assembler_ptr createAssembler(std::string type,
201  const DataMap& options) const;
202 
207  const double *getLength() const { return m_length; }
208 
213  const double *getElementLength() const { return m_dx; }
214 
220  virtual RankVector getOwnerVector(int fsType) const;
221 
222 protected:
223  virtual dim_t getNumNodes() const;
224  virtual dim_t getNumElements() const;
225  virtual dim_t getNumFaceElements() const;
226  virtual dim_t getNumDOF() const;
227  virtual dim_t getNumDOFInAxis(unsigned axis) const;
228  virtual index_t getFirstInDim(unsigned axis) const;
229 
230  virtual IndexVector getDiagonalIndices(bool upperOnly) const;
231  virtual void assembleCoordinates(escript::Data& arg) const;
232  virtual void assembleGradient(escript::Data& out,
233  const escript::Data& in) const;
234  virtual void assembleIntegrate(DoubleVector& integrals,
235  const escript::Data& arg) const;
236  virtual paso::SystemMatrixPattern_ptr getPasoMatrixPattern(
237  bool reducedRowOrder, bool reducedColOrder) const;
238  virtual void interpolateNodesOnElements(escript::Data& out,
239  const escript::Data& in, bool reduced) const;
240  virtual void interpolateNodesOnFaces(escript::Data& out,
241  const escript::Data& in,
242  bool reduced) const;
243  virtual void nodesToDOF(escript::Data& out, const escript::Data& in) const;
244  virtual void dofToNodes(escript::Data& out, const escript::Data& in) const;
245  virtual dim_t getDofOfNode(dim_t node) const;
246 
247  virtual void populateSampleIds();
248  virtual void populateDofMap();
249  virtual std::vector<IndexVector> getConnections() const;
250  virtual void addToMatrixAndRHS(escript::AbstractSystemMatrix* S, escript::Data& F,
251  const DoubleVector& EM_S, const DoubleVector& EM_F,
252  bool addS, bool addF, index_t firstNode, int nEq=1, int nComp=1) const;
253 
254  template<typename ValueType>
255  void readBinaryGridImpl(escript::Data& out, const std::string& filename,
256  const ReaderParameters& params) const;
257 
258  template<typename ValueType>
259  void readBinaryGridZippedImpl(escript::Data& out,
260  const std::string& filename, const ReaderParameters& params) const;
261 
262  template<typename ValueType>
263  void writeBinaryGridImpl(const escript::Data& in,
264  const std::string& filename, int byteOrder) const;
265 
266  virtual dim_t findNode(const double *coords) const;
267 
268 
269  escript::Data randomFillWorker(const escript::DataTypes::ShapeType& shape,
270  long seed, const boost::python::tuple& filter) const;
271 
273  dim_t m_gNE[2];
274 
276  double m_origin[2];
277 
279  double m_length[2];
280 
282  double m_dx[2];
283 
285  int m_NX[2];
286 
288  dim_t m_NE[2];
289 
291  dim_t m_ownNE[2];
292 
294  dim_t m_NN[2];
295 
297  dim_t m_offset[2];
298 
300  dim_t m_faceCount[4];
301 
305 
311 
312  // vector with first node id on each rank
314 
315  // vector that maps each node to a DOF index (used for the coupler)
317 
318  // Paso connector used by the system matrix and to interpolate DOF to
319  // nodes
321 
322  // the Paso System Matrix pattern
324 };
325 
328 {
329  return m_dofMap[node];
330 }
331 
333 {
334  return (m_gNE[0]+1)*(m_gNE[1]+1);
335 }
336 
337 inline double Rectangle::getLocalCoordinate(index_t index, int dim) const
338 {
339  EsysAssert((dim>=0 && dim<2), "'dim' out of bounds");
340  EsysAssert((index>=0 && index<m_NN[dim]), "'index' out of bounds");
341  return m_origin[dim]+m_dx[dim]*(m_offset[dim]+index);
342 }
343 
344 inline boost::python::tuple Rectangle::getGridParameters() const
345 {
346  return boost::python::make_tuple(
347  boost::python::make_tuple(m_origin[0], m_origin[1]),
348  boost::python::make_tuple(m_dx[0], m_dx[1]),
349  boost::python::make_tuple(m_gNE[0], m_gNE[1]));
350 }
351 
352 //protected
354 {
355  return (m_gNE[0]+1)/m_NX[0]*(m_gNE[1]+1)/m_NX[1];
356 }
357 
358 //protected
359 inline dim_t Rectangle::getNumDOFInAxis(unsigned axis) const
360 {
361  EsysAssert((axis < m_numDim), "Invalid axis");
362  return (m_gNE[axis]+1)/m_NX[axis];
363 }
364 
365 //protected
367 {
368  return m_NN[0]*m_NN[1];
369 }
370 
371 //protected
373 {
374  return m_NE[0]*m_NE[1];
375 }
376 
377 //protected
379 {
380  return m_faceCount[0] + m_faceCount[1] + m_faceCount[2] + m_faceCount[3];
381 }
382 
383 //protected
384 inline index_t Rectangle::getFirstInDim(unsigned axis) const
385 {
386  return m_offset[axis] == 0 ? 0 : 1;
387 }
388 
389 } // end of namespace ripley
390 
391 #endif // __RIPLEY_RECTANGLE_H__
392 
Definition: FunctionSpace.h:34
virtual dim_t getNumFaceElements() const
returns the number of face elements on current MPI rank
Definition: ripley/src/Rectangle.h:378
virtual const int * getNumSubdivisionsPerDim() const
returns the number of spatial subdivisions in each dimension
Definition: ripley/src/Rectangle.h:174
virtual dim_t getNumNodes() const
returns the number of nodes per MPI rank
Definition: ripley/src/Rectangle.h:366
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:117
IndexVector m_elementId
Definition: ripley/src/Rectangle.h:309
IndexVector m_nodeId
Definition: ripley/src/Rectangle.h:308
virtual boost::python::tuple getGridParameters() const
returns the tuple (origin, spacing, number_of_elements)
Definition: ripley/src/Rectangle.h:344
Definition: ripley/src/WaveAssembler2D.h:24
virtual const dim_t * getNumElementsPerDim() const
returns the number of elements per MPI rank in each dimension
Definition: ripley/src/Rectangle.h:155
Definition: LameAssembler2D.h:24
virtual dim_t getNumElements() const
returns the number of elements per MPI rank
Definition: ripley/src/Rectangle.h:372
const double * getLength() const
returns the lengths of the domain
Definition: ripley/src/Rectangle.h:207
virtual index_t getFirstInDim(unsigned axis) const
Definition: ripley/src/Rectangle.h:384
IndexVector m_dofId
vector of sample reference identifiers
Definition: ripley/src/Rectangle.h:307
Definition: ripley/src/DefaultAssembler2D.h:24
std::vector< int > ShapeType
The shape of a single datapoint.
Definition: DataTypes.h:38
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:162
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:65
boost::shared_ptr< SystemMatrixPattern > SystemMatrixPattern_ptr
Definition: SystemMatrixPattern.h:38
IndexVector m_nodeDistribution
Definition: ripley/src/Rectangle.h:313
std::map< std::string, int > TagMap
Definition: Ripley.h:41
virtual IndexVector getNodeDistribution() const
returns the node distribution vector
Definition: ripley/src/Rectangle.h:168
virtual dim_t getNumDOF() const
returns the number of degrees of freedom per MPI rank
Definition: ripley/src/Rectangle.h:353
Rectangle is the 2-dimensional implementation of a RipleyDomain.
Definition: ripley/src/Rectangle.h:29
std::vector< index_t > IndexVector
Definition: Ripley.h:38
virtual const dim_t * getNumNodesPerDim() const
returns the number of nodes per MPI rank in each dimension
Definition: ripley/src/Rectangle.h:149
virtual dim_t getNumDataPointsGlobal() const
returns the number of data points summed across all MPI processes
Definition: ripley/src/Rectangle.h:332
std::map< std::string, escript::Data > DataMap
Definition: ripley/src/domainhelpers.h:24
boost::shared_ptr< SubWorld > SubWorld_ptr
Definition: SubWorld.h:142
Structure that wraps parameters for the grid reading routines.
Definition: ripley/src/RipleyDomain.h:52
Data represents a collection of datapoints.
Definition: Data.h:68
#define EsysAssert(AssertTest, AssertMessage)
EsysAssert is a MACRO that will throw an exception if the boolean condition specified is false...
Definition: EsysAssert.h:96
const double * getElementLength() const
returns the lengths of an element
Definition: ripley/src/Rectangle.h:213
IndexVector m_faceId
Definition: ripley/src/Rectangle.h:310
RipleyDomain extends the AbstractContinuousDomain interface for the Ripley library and is the base cl...
Definition: ripley/src/RipleyDomain.h:85
IndexVector m_faceOffset
Definition: ripley/src/Rectangle.h:304
IndexVector m_dofMap
Definition: ripley/src/Rectangle.h:316
int index_t
Definition: types.h:24
std::vector< Esys_MPI_rank > RankVector
Definition: Ripley.h:40
virtual dim_t getDofOfNode(dim_t node) const
Definition: ripley/src/Rectangle.h:327
boost::shared_ptr< Connector > Connector_ptr
Definition: Coupler.h:35
index_t dim_t
Definition: types.h:27
Base class for escript system matrices.
Definition: AbstractSystemMatrix.h:37
Definition: ripley/src/AbstractAssembler.h:25
paso::Connector_ptr m_connector
Definition: ripley/src/Rectangle.h:320
Base class for all escript domains.
Definition: AbstractDomain.h:45
#define RIPLEY_DLL_API
Definition: ripley/src/system_dep.h:22
virtual dim_t getNumDOFInAxis(unsigned axis) const
Definition: ripley/src/Rectangle.h:359
paso::SystemMatrixPattern_ptr m_pattern
Definition: ripley/src/Rectangle.h:323
#define S(_J_, _I_)
Definition: ShapeFunctions.cpp:121
std::vector< double > DoubleVector
Definition: Ripley.h:39
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:337