escript  Revision_4925
Brick.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_BRICK_H__
18 #define __RIPLEY_BRICK_H__
19 
20 #include <paso/Coupler.h>
21 #include <ripley/RipleyDomain.h>
22 
23 namespace ripley {
24 
30 {
31  friend class DefaultAssembler3D;
32  friend class WaveAssembler3D;
33  friend class LameAssembler3D;
34 public:
35 
43  Brick(int n0, int n1, int n2, double x0, double y0, double z0, double x1,
44  double y1, double z1, int d0=-1, int d1=-1, int d2=-1,
45  const std::vector<double>& points = std::vector<double>(),
46  const std::vector<int>& tags = std::vector<int>(),
47  const simap_t& tagnamestonums = simap_t());
48 
53  ~Brick();
54 
59  virtual std::string getDescription() const;
60 
64  virtual bool operator==(const escript::AbstractDomain& other) const;
65 
71  void dump(const std::string& filename) const;
72 
75  virtual void readNcGrid(escript::Data& out, std::string filename,
76  std::string varname, const ReaderParameters& params) const;
77 
80  virtual void readBinaryGrid(escript::Data& out, std::string filename,
81  const ReaderParameters& params) const;
82 
83 #ifdef USE_BOOSTIO
84  virtual void readBinaryGridFromZipped(escript::Data& out, std::string filename,
85  const ReaderParameters& params) const;
86 #endif
87 
90  virtual void writeBinaryGrid(const escript::Data& in,
91  std::string filename,
92  int byteOrder, int dataType) const;
93 
99  const int* borrowSampleReferenceIDs(int fsType) const;
100 
105  virtual bool ownSample(int fsType, index_t id) const;
106 
113  virtual void setToNormal(escript::Data& out) const;
114 
120  virtual void setToSize(escript::Data& out) const;
121 
126  virtual int getNumDataPointsGlobal() const;
127 
133  virtual void Print_Mesh_Info(const bool full=false) const;
134 
139  virtual const int* getNumNodesPerDim() const { return m_NN; }
140 
145  virtual const int* getNumElementsPerDim() const { return m_NE; }
146 
152  virtual const int* getNumFacesPerBoundary() const { return m_faceCount; }
153 
158  virtual IndexVector getNodeDistribution() const { return m_nodeDistribution; }
159 
164  virtual const int* getNumSubdivisionsPerDim() const { return m_NX; }
165 
170  virtual double getLocalCoordinate(int index, int dim) const;
171 
176  virtual boost::python::tuple getGridParameters() const;
177 
182  virtual escript::Data randomFill(const escript::DataTypes::ShapeType& shape,
183  const escript::FunctionSpace& what, long seed, const boost::python::tuple& filter) const;
184 
185 
186 protected:
187  virtual dim_t getNumNodes() const;
188  virtual dim_t getNumElements() const;
189  virtual dim_t getNumFaceElements() const;
190  virtual dim_t getNumDOF() const;
191  virtual dim_t insertNeighbourNodes(IndexVector& index, index_t node) const;
192  virtual void assembleCoordinates(escript::Data& arg) const;
193  virtual void assembleGradient(escript::Data& out, const escript::Data& in) const;
194  virtual void assembleIntegrate(DoubleVector& integrals, const escript::Data& arg) const;
195  virtual paso::SystemMatrixPattern_ptr getPattern(bool reducedRowOrder, bool reducedColOrder) const;
196  virtual void interpolateNodesOnElements(escript::Data& out,
197  const escript::Data& in, bool reduced) const;
198  virtual void interpolateNodesOnFaces(escript::Data& out,
199  const escript::Data& in,
200  bool reduced) const;
201  virtual void nodesToDOF(escript::Data& out, const escript::Data& in) const;
202  virtual void dofToNodes(escript::Data& out, const escript::Data& in) const;
203  virtual int getDofOfNode(int node) const;
204  void setAssembler(std::string type, std::map<std::string,
205  escript::Data> constants);
206 
207 private:
208  void populateSampleIds();
209  void createPattern();
210  void addToMatrixAndRHS(paso::SystemMatrix_ptr S, escript::Data& F,
211  const DoubleVector& EM_S, const DoubleVector& EM_F,
212  bool addS, bool addF, int firstNode, int nEq=1, int nComp=1) const;
213 
214  template<typename ValueType>
215  void readBinaryGridImpl(escript::Data& out, const std::string& filename,
216  const ReaderParameters& params) const;
217  template<typename ValueType>
218  void readBinaryGridZippedImpl(escript::Data& out, const std::string& filename,
219  const ReaderParameters& params) const;
220  template<typename ValueType>
221  void writeBinaryGridImpl(const escript::Data& in,
222  const std::string& filename, int byteOrder) const;
223 
224  int findNode(const double *coords) const;
225 
226 
227  virtual escript::Data randomFillWorker(const escript::DataTypes::ShapeType& shape, long seed, const boost::python::tuple& filter) const;
228 
230  dim_t m_gNE[3];
231 
233  double m_origin[3];
234 
236  double m_length[3];
237 
239  double m_dx[3];
240 
242  int m_NX[3];
243 
245  dim_t m_NE[3];
246 
248  dim_t m_ownNE[3];
249 
251  dim_t m_NN[3];
252 
254  dim_t m_offset[3];
255 
257  int m_faceCount[6];
258 
263 
269 
270  // vector with first node id on each rank
272 
273  // vector that maps each node to a DOF index (used for the coupler)
275 
276  // Paso connector used by the system matrix and to interpolate DOF to
277  // nodes
279 
280  // the Paso System Matrix pattern
282 };
283 
285 inline int Brick::getDofOfNode(int node) const {
286  return m_dofMap[node];
287 }
288 
290 {
291  return (m_gNE[0]+1)*(m_gNE[1]+1)*(m_gNE[2]+1);
292 }
293 
294 inline double Brick::getLocalCoordinate(int index, int dim) const
295 {
296  EsysAssert((dim>=0 && dim<3), "'dim' out of bounds");
297  EsysAssert((index>=0 && index<m_NN[dim]), "'index' out of bounds");
298  return m_origin[dim]+m_dx[dim]*(m_offset[dim]+index);
299 }
300 
301 inline boost::python::tuple Brick::getGridParameters() const
302 {
303  return boost::python::make_tuple(
304  boost::python::make_tuple(m_origin[0], m_origin[1], m_origin[2]),
305  boost::python::make_tuple(m_dx[0], m_dx[1], m_dx[2]),
306  boost::python::make_tuple(m_gNE[0], m_gNE[1], m_gNE[2]));
307 }
308 
310  bool reducedColOrder) const
311 {
312  // TODO: reduced
313  return m_pattern;
314 }
315 
316 
317 //protected
318 inline dim_t Brick::getNumDOF() const
319 {
320  return (m_gNE[0]+1)/m_NX[0]*(m_gNE[1]+1)/m_NX[1]*(m_gNE[2]+1)/m_NX[2];
321 }
322 
323 //protected
324 inline dim_t Brick::getNumNodes() const
325 {
326  return m_NN[0]*m_NN[1]*m_NN[2];
327 }
328 
329 //protected
331 {
332  return m_NE[0]*m_NE[1]*m_NE[2];
333 }
334 
335 //protected
337 {
338  return m_faceCount[0] + m_faceCount[1] + m_faceCount[2]
339  + m_faceCount[3] + m_faceCount[4] + m_faceCount[5];
340 }
341 
342 } // end of namespace ripley
343 
344 #endif // __RIPLEY_BRICK_H__
345 
Give a short description of what FunctionSpace does.
Definition: FunctionSpace.h:46
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
virtual dim_t getNumFaceElements() const
returns the number of face elements on current MPI rank
Definition: Brick.h:336
virtual const int * getNumNodesPerDim() const
returns the number of nodes per MPI rank in each dimension
Definition: Brick.h:139
virtual dim_t getNumDOF() const
returns the number of degrees of freedom per MPI rank
Definition: Brick.h:318
virtual boost::python::tuple getGridParameters() const
returns the tuple (origin, spacing, number_of_elements)
Definition: Brick.h:301
dim_t m_offset[3]
first node on this rank is at (offset0,offset1,offset2) in global mesh
Definition: Brick.h:254
std::vector< int > ShapeType
The shape of a single datapoint.
Definition: DataTypes.h:38
virtual int getDofOfNode(int node) const
Definition: Brick.h:285
virtual int getNumDataPointsGlobal() const
returns the number of data points summed across all MPI processes
Definition: Brick.h:289
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
double m_dx[3]
grid spacings / cell sizes of domain
Definition: Brick.h:239
boost::shared_ptr< SystemMatrixPattern > SystemMatrixPattern_ptr
Definition: SystemMatrixPattern.h:38
boost::shared_ptr< SystemMatrix > SystemMatrix_ptr
Definition: SystemMatrix.h:38
virtual const int * getNumSubdivisionsPerDim() const
returns the number of spatial subdivisions in each dimension
Definition: Brick.h:164
virtual dim_t getNumNodes() const
returns the number of nodes per MPI rank
Definition: Brick.h:324
IndexVector m_nodeDistribution
Definition: Brick.h:271
std::map< std::string, int > simap_t
Definition: ripley/src/RipleyDomain.h:56
std::vector< index_t > IndexVector
Definition: Ripley.h:38
Structure that wraps parameters for the grid reading routines.
Definition: ripley/src/RipleyDomain.h:63
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
dim_t m_NE[3]
number of elements for this rank in each dimension including shared
Definition: Brick.h:245
RipleyDomain extends the AbstractContinuousDomain interface for the Ripley library and is the base cl...
Definition: ripley/src/RipleyDomain.h:96
Definition: WaveAssembler3D.h:29
Definition: LameAssembler3D.h:29
virtual IndexVector getNodeDistribution() const
returns the node distribution vector
Definition: Brick.h:158
dim_t m_NN[3]
number of nodes for this rank in each dimension
Definition: Brick.h:251
int index_t
Definition: types.h:25
int m_faceCount[6]
number of face elements per edge (left, right, bottom, top, front, back)
Definition: Brick.h:257
Brick is the 3-dimensional implementation of a RipleyDomain.
Definition: Brick.h:29
paso::Connector_ptr m_connector
Definition: Brick.h:278
Definition: DefaultAssembler3D.h:29
virtual double getLocalCoordinate(int index, int dim) const
returns the index'th coordinate value in given dimension for this rank
Definition: Brick.h:294
boost::shared_ptr< Connector > Connector_ptr
Definition: Coupler.h:35
double m_origin[3]
origin of domain
Definition: Brick.h:233
IndexVector m_nodeId
Definition: Brick.h:266
IndexVector m_dofId
vector of sample reference identifiers
Definition: Brick.h:265
virtual const int * getNumFacesPerBoundary() const
returns the number of face elements in the order (left,right,bottom,top,front,back) on current MPI ra...
Definition: Brick.h:152
paso::SystemMatrixPattern_ptr m_pattern
Definition: Brick.h:281
Definition: AbstractDomain.h:62
virtual paso::SystemMatrixPattern_ptr getPattern(bool reducedRowOrder, bool reducedColOrder) const
returns the Paso system matrix pattern
Definition: Brick.h:309
virtual const int * getNumElementsPerDim() const
returns the number of elements per MPI rank in each dimension
Definition: Brick.h:145
#define RIPLEY_DLL_API
Definition: ripley/src/system_dep.h:35
int dim_t
Definition: types.h:24
IndexVector m_faceId
Definition: Brick.h:268
virtual dim_t getNumElements() const
returns the number of elements per MPI rank
Definition: Brick.h:330
IndexVector m_elementId
Definition: Brick.h:267
#define S(_J_, _I_)
Definition: ShapeFunctions.cpp:121
dim_t m_gNE[3]
total number of elements in each dimension
Definition: Brick.h:230
std::vector< double > DoubleVector
Definition: Ripley.h:39
IndexVector m_dofMap
Definition: Brick.h:274
IndexVector m_faceOffset
Definition: Brick.h:262
int m_NX[3]
number of spatial subdivisions
Definition: Brick.h:242