escript  Revision_4925
Rectangle.h
Go to the documentation of this file.
1 
2 /*****************************************************************************
3 *
4 * Copyright (c) 2003-2014 by University of Queensland
5 * http://www.uq.edu.au
6 *
7 * Primary Business: Queensland, Australia
8 * Licensed under the Open Software License version 3.0
9 * http://www.opensource.org/licenses/osl-3.0.php
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 public:
32 
40  Rectangle(int n0, int n1, double x0, double y0, double x1, double y1,
41  int d0=-1, int d1=-1,
42  const std::vector<double>& points = std::vector<double>(),
43  const std::vector<int>& tags = std::vector<int>(),
44  const simap_t& tagnamestonums = simap_t());
45 
50  ~Rectangle();
51 
56  virtual std::string getDescription() const;
57 
61  virtual bool operator==(const escript::AbstractDomain& other) const;
62 
68  void dump(const std::string& filename) const;
69 
72  virtual void readNcGrid(escript::Data& out, std::string filename,
73  std::string varname, const ReaderParameters& params) const;
74 
77  virtual void readBinaryGrid(escript::Data& out, std::string filename,
78  const ReaderParameters& params) const;
79 #ifdef USE_BOOSTIO
80 
82  virtual void readBinaryGridFromZipped(escript::Data& out, std::string filename,
83  const ReaderParameters& params) const;
84 #endif
85 
88  virtual void writeBinaryGrid(const escript::Data& in,
89  std::string filename,
90  int byteOrder, int dataType) const;
91 
97  const int* borrowSampleReferenceIDs(int fsType) const;
98 
103  virtual bool ownSample(int fs_code, index_t id) const;
104 
111  virtual void setToNormal(escript::Data& out) const;
112 
118  virtual void setToSize(escript::Data& out) const;
119 
124  virtual int getNumDataPointsGlobal() const;
125 
131  virtual void Print_Mesh_Info(const bool full=false) const;
132 
137  virtual const int* getNumNodesPerDim() const { return m_NN; }
138 
143  virtual const int* getNumElementsPerDim() const { return m_NE; }
144 
150  virtual const int* getNumFacesPerBoundary() const { return m_faceCount; }
151 
156  virtual IndexVector getNodeDistribution() const { return m_nodeDistribution; }
157 
162  virtual const int* getNumSubdivisionsPerDim() const { return m_NX; }
163 
168  virtual double getLocalCoordinate(int index, int dim) const;
169 
174  virtual boost::python::tuple getGridParameters() const;
175 
180  virtual escript::Data randomFill(const escript::DataTypes::ShapeType& shape,
181  const escript::FunctionSpace& what, long seed, const boost::python::tuple& filter) const;
182 
183 
188  virtual void setAssembler(std::string type, std::map<std::string, escript::Data> options);
189 
190 
191 protected:
192  virtual dim_t getNumNodes() const;
193  virtual dim_t getNumElements() const;
194  virtual dim_t getNumFaceElements() const;
195  virtual dim_t getNumDOF() const;
196  virtual dim_t insertNeighbourNodes(IndexVector& index, index_t node) const;
197  virtual void assembleCoordinates(escript::Data& arg) const;
198  virtual void assembleGradient(escript::Data& out,
199  const escript::Data& in) const;
200  virtual void assembleIntegrate(DoubleVector& integrals,
201  const escript::Data& arg) const;
202  virtual paso::SystemMatrixPattern_ptr getPattern(bool reducedRowOrder, bool reducedColOrder) const;
203  virtual void interpolateNodesOnElements(escript::Data& out,
204  const escript::Data& in, bool reduced) const;
205  virtual void interpolateNodesOnFaces(escript::Data& out,
206  const escript::Data& in,
207  bool reduced) const;
208  virtual void nodesToDOF(escript::Data& out, const escript::Data& in) const;
209  virtual void dofToNodes(escript::Data& out, const escript::Data& in) const;
210  virtual int getDofOfNode(int node) const;
211 
212 private:
213  void populateSampleIds();
214  void createPattern();
215  void addToMatrixAndRHS(paso::SystemMatrix_ptr S, escript::Data& F,
216  const DoubleVector& EM_S, const DoubleVector& EM_F,
217  bool addS, bool addF, int firstNode, int nEq=1, int nComp=1) const;
218 
219  template<typename ValueType>
220  void readBinaryGridImpl(escript::Data& out, const std::string& filename,
221  const ReaderParameters& params) const;
222 
223  template<typename ValueType>
224  void readBinaryGridZippedImpl(escript::Data& out,
225  const std::string& filename, const ReaderParameters& params) const;
226 
227  template<typename ValueType>
228  void writeBinaryGridImpl(const escript::Data& in,
229  const std::string& filename, int byteOrder) const;
230 
231  int findNode(const double *coords) const;
232 
233 
234  escript::Data randomFillWorker(const escript::DataTypes::ShapeType& shape,
235  long seed, const boost::python::tuple& filter) const;
236 
238  dim_t m_gNE[2];
239 
241  double m_origin[2];
242 
244  double m_length[2];
245 
247  double m_dx[2];
248 
250  dim_t m_NX[2];
251 
253  dim_t m_NE[2];
254 
256  dim_t m_ownNE[2];
257 
259  dim_t m_NN[2];
260 
262  dim_t m_offset[2];
263 
265  int m_faceCount[4];
266 
270 
276 
277  // vector with first node id on each rank
279 
280  // vector that maps each node to a DOF index (used for the coupler)
282 
283  // Paso connector used by the system matrix and to interpolate DOF to
284  // nodes
286 
287  // the Paso System Matrix pattern
289 
290  friend class DefaultAssembler2D;
291  friend class WaveAssembler2D;
292  friend class LameAssembler2D;
293 };
294 
296 inline int Rectangle::getDofOfNode(int node) const {
297  return m_dofMap[node];
298 }
299 
301 {
302  return (m_gNE[0]+1)*(m_gNE[1]+1);
303 }
304 
305 inline double Rectangle::getLocalCoordinate(int index, int dim) const
306 {
307  EsysAssert((dim>=0 && dim<2), "'dim' out of bounds");
308  EsysAssert((index>=0 && index<m_NN[dim]), "'index' out of bounds");
309  return m_origin[dim]+m_dx[dim]*(m_offset[dim]+index);
310 }
311 
312 inline boost::python::tuple Rectangle::getGridParameters() const
313 {
314  return boost::python::make_tuple(
315  boost::python::make_tuple(m_origin[0], m_origin[1]),
316  boost::python::make_tuple(m_dx[0], m_dx[1]),
317  boost::python::make_tuple(m_gNE[0], m_gNE[1]));
318 }
319 
321  bool reducedColOrder) const
322 {
323  // TODO: reduced
324  return m_pattern;
325 }
326 
327 
328 //protected
330 {
331  return (m_gNE[0]+1)/m_NX[0]*(m_gNE[1]+1)/m_NX[1];
332 }
333 
334 //protected
336 {
337  return m_NN[0]*m_NN[1];
338 }
339 
340 //protected
342 {
343  return m_NE[0]*m_NE[1];
344 }
345 
346 //protected
348 {
349  return m_faceCount[0] + m_faceCount[1] + m_faceCount[2] + m_faceCount[3];
350 }
351 
352 
353 } // end of namespace ripley
354 
355 #endif // __RIPLEY_RECTANGLE_H__
356 
Give a short description of what FunctionSpace does.
Definition: FunctionSpace.h:46
virtual dim_t getNumFaceElements() const
returns the number of face elements on current MPI rank
Definition: Rectangle.h:347
virtual const int * getNumSubdivisionsPerDim() const
returns the number of spatial subdivisions in each dimension
Definition: Rectangle.h:162
virtual dim_t getNumNodes() const
returns the number of nodes per MPI rank
Definition: Rectangle.h:335
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:109
IndexVector m_elementId
Definition: Rectangle.h:274
IndexVector m_nodeId
Definition: Rectangle.h:273
virtual boost::python::tuple getGridParameters() const
returns the tuple (origin, spacing, number_of_elements)
Definition: Rectangle.h:312
Definition: WaveAssembler2D.h:29
Definition: LameAssembler2D.h:29
virtual dim_t getNumElements() const
returns the number of elements per MPI rank
Definition: Rectangle.h:341
IndexVector m_dofId
vector of sample reference identifiers
Definition: Rectangle.h:272
virtual paso::SystemMatrixPattern_ptr getPattern(bool reducedRowOrder, bool reducedColOrder) const
returns the Paso system matrix pattern
Definition: Rectangle.h:320
virtual double getLocalCoordinate(int index, int dim) const
returns the index'th coordinate value in given dimension for this rank
Definition: Rectangle.h:305
Definition: DefaultAssembler2D.h:29
std::vector< int > ShapeType
The shape of a single datapoint.
Definition: DataTypes.h:38
virtual int getNumDataPointsGlobal() const
returns the number of data points summed across all MPI processes
Definition: Rectangle.h:300
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:57
boost::shared_ptr< SystemMatrixPattern > SystemMatrixPattern_ptr
Definition: SystemMatrixPattern.h:38
virtual const int * getNumFacesPerBoundary() const
returns the number of face elements in the order (left,right,bottom,top) on current MPI rank ...
Definition: Rectangle.h:150
IndexVector m_nodeDistribution
Definition: Rectangle.h:278
boost::shared_ptr< SystemMatrix > SystemMatrix_ptr
Definition: SystemMatrix.h:38
virtual IndexVector getNodeDistribution() const
returns the node distribution vector
Definition: Rectangle.h:156
std::map< std::string, int > simap_t
Definition: ripley/src/RipleyDomain.h:56
virtual dim_t getNumDOF() const
returns the number of degrees of freedom per MPI rank
Definition: Rectangle.h:329
Rectangle is the 2-dimensional implementation of a RipleyDomain.
Definition: Rectangle.h:29
std::vector< index_t > IndexVector
Definition: Ripley.h:38
dim_t m_NX[2]
number of spatial subdivisions
Definition: Rectangle.h:250
Structure that wraps parameters for the grid reading routines.
Definition: ripley/src/RipleyDomain.h:63
int m_faceCount[4]
number of face elements per edge (left, right, bottom, top)
Definition: Rectangle.h:265
Data represents a collection of datapoints.
Definition: Data.h:71
#define EsysAssert(AssertTest, AssertMessage)
EsysAssert is a MACRO that will throw an exception if the boolean condition specified is false...
Definition: EsysAssert.h:96
double m_dx[2]
grid spacings / cell sizes of domain
Definition: Rectangle.h:247
IndexVector m_faceId
Definition: Rectangle.h:275
RipleyDomain extends the AbstractContinuousDomain interface for the Ripley library and is the base cl...
Definition: ripley/src/RipleyDomain.h:96
IndexVector m_faceOffset
Definition: Rectangle.h:269
dim_t m_gNE[2]
total number of elements in each dimension
Definition: Rectangle.h:238
IndexVector m_dofMap
Definition: Rectangle.h:281
int index_t
Definition: types.h:25
dim_t m_offset[2]
first node on this rank is at (offset0,offset1) in global mesh
Definition: Rectangle.h:262
boost::shared_ptr< Connector > Connector_ptr
Definition: Coupler.h:35
virtual const int * getNumNodesPerDim() const
returns the number of nodes per MPI rank in each dimension
Definition: Rectangle.h:137
double m_origin[2]
origin of domain
Definition: Rectangle.h:241
virtual int getDofOfNode(int node) const
Definition: Rectangle.h:296
paso::Connector_ptr m_connector
Definition: Rectangle.h:285
Definition: AbstractDomain.h:62
virtual const int * getNumElementsPerDim() const
returns the number of elements per MPI rank in each dimension
Definition: Rectangle.h:143
#define RIPLEY_DLL_API
Definition: ripley/src/system_dep.h:35
int dim_t
Definition: types.h:24
dim_t m_NN[2]
number of nodes for this rank in each dimension
Definition: Rectangle.h:259
paso::SystemMatrixPattern_ptr m_pattern
Definition: Rectangle.h:288
dim_t m_NE[2]
number of elements for this rank in each dimension including shared
Definition: Rectangle.h:253
#define S(_J_, _I_)
Definition: ShapeFunctions.cpp:121
std::vector< double > DoubleVector
Definition: Ripley.h:39