escript  Revision_
speckley/src/Brick.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 __Speckley_BRICK_H__
18 #define __Speckley_BRICK_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  friend class DefaultAssembler3D;
35  friend class WaveAssembler3D;
36 public:
37 
45  Brick(int order, dim_t n0, dim_t n1, dim_t n2, double x0, double y0, double z0, double x1,
46  double y1, double z1, int d0=-1, int d1=-1, int d2=-1,
47  const std::vector<double>& points = std::vector<double>(),
48  const std::vector<int>& tags = std::vector<int>(),
49  const TagMap& tagnamestonums = TagMap(),
51 
56  ~Brick();
57 
62  virtual std::string getDescription() const;
63 
67  virtual bool operator==(const escript::AbstractDomain& other) const;
68 
74  virtual void write(const std::string& filename) const;
75 
81  void dump(const std::string& filename) const;
82 
85  virtual void readNcGrid(escript::Data& out, std::string filename,
86  std::string varname, const ReaderParameters& params) const;
87 
90  virtual void readBinaryGrid(escript::Data& out, std::string filename,
91  const ReaderParameters& params) const;
92 
93  virtual void readBinaryGridFromZipped(escript::Data& out,
94  std::string filename, 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,
192  long seed,
193  const boost::python::tuple& filter) const;
194 
200  virtual void interpolateAcross(escript::Data& target,
201  const escript::Data& source) const;
202 
207  virtual bool probeInterpolationAcross(int, const escript::AbstractDomain&,
208  int) const;
209 
214  const double *getLength() const { return m_length; }
215 
216 protected:
217  virtual dim_t getNumNodes() const;
218  virtual dim_t getNumElements() const;
219  virtual dim_t getNumDOF() const;
220  virtual void assembleCoordinates(escript::Data& arg) const;
221  virtual void assembleGradient(escript::Data& out,
222  const escript::Data& in) const;
223  virtual void assembleIntegrate(std::vector<real_t>& integrals,
224  const escript::Data& arg) const;
225  virtual void assembleIntegrate(std::vector<cplx_t>& integrals,
226  const escript::Data& arg) const;
227  virtual void interpolateNodesOnElements(escript::Data& out,
228  const escript::Data& in,
229  bool reduced) const;
230  virtual void interpolateElementsOnNodes(escript::Data& out,
231  const escript::Data& in) const;
232  virtual dim_t getDofOfNode(dim_t node) const;
233  Assembler_ptr createAssembler(std::string type, const DataMap& constants) const;
234  virtual void reduceElements(escript::Data& out, const escript::Data& in) const;
235 #ifdef ESYS_MPI
236  virtual void balanceNeighbours(escript::Data& data, bool average) const;
237 #endif
238 
239 private:
240  template<typename Scalar>
241  void gradient_order2(escript::Data&, const escript::Data&) const;
242  template<typename Scalar>
243  void gradient_order3(escript::Data&, const escript::Data&) const;
244  template<typename Scalar>
245  void gradient_order4(escript::Data&, const escript::Data&) const;
246  template<typename Scalar>
247  void gradient_order5(escript::Data&, const escript::Data&) const;
248  template<typename Scalar>
249  void gradient_order6(escript::Data&, const escript::Data&) const;
250  template<typename Scalar>
251  void gradient_order7(escript::Data&, const escript::Data&) const;
252  template<typename Scalar>
253  void gradient_order8(escript::Data&, const escript::Data&) const;
254  template<typename Scalar>
255  void gradient_order9(escript::Data&, const escript::Data&) const;
256  template<typename Scalar>
257  void gradient_order10(escript::Data&, const escript::Data&) const;
258 
259  template<typename Scalar>
260  void reduction_order2(const escript::Data&, escript::Data&) const;
261  template<typename Scalar>
262  void reduction_order3(const escript::Data&, escript::Data&) const;
263  template<typename Scalar>
264  void reduction_order4(const escript::Data&, escript::Data&) const;
265  template<typename Scalar>
266  void reduction_order5(const escript::Data&, escript::Data&) const;
267  template<typename Scalar>
268  void reduction_order6(const escript::Data&, escript::Data&) const;
269  template<typename Scalar>
270  void reduction_order7(const escript::Data&, escript::Data&) const;
271  template<typename Scalar>
272  void reduction_order8(const escript::Data&, escript::Data&) const;
273  template<typename Scalar>
274  void reduction_order9(const escript::Data&, escript::Data&) const;
275  template<typename Scalar>
276  void reduction_order10(const escript::Data&, escript::Data&) const;
277 
278  template<typename Scalar>
279  void integral_order2(std::vector<Scalar>&, const escript::Data&) const;
280  template<typename Scalar>
281  void integral_order3(std::vector<Scalar>&, const escript::Data&) const;
282  template<typename Scalar>
283  void integral_order4(std::vector<Scalar>&, const escript::Data&) const;
284  template<typename Scalar>
285  void integral_order5(std::vector<Scalar>&, const escript::Data&) const;
286  template<typename Scalar>
287  void integral_order6(std::vector<Scalar>&, const escript::Data&) const;
288  template<typename Scalar>
289  void integral_order7(std::vector<Scalar>&, const escript::Data&) const;
290  template<typename Scalar>
291  void integral_order8(std::vector<Scalar>&, const escript::Data&) const;
292  template<typename Scalar>
293  void integral_order9(std::vector<Scalar>&, const escript::Data&) const;
294  template<typename Scalar>
295  void integral_order10(std::vector<Scalar>&, const escript::Data&) const;
296 
297  template<typename Scalar>
298  void assembleIntegrateWorker(std::vector<Scalar>& integrals,
299  const escript::Data& arg) const;
300 
301  template<typename Scalar>
302  void interpolateNodesOnElementsWorker(escript::Data& out,
303  const escript::Data& in,
304  bool reduced) const;
305 #ifdef ESYS_MPI
306  void setCornerNeighbours();
307  void shareEdges(escript::Data& out, int rx, int ry, int rz) const;
308  void shareFaces(escript::Data& out, int rx, int ry, int rz) const;
309  void shareCorners(escript::Data& out) const;
310 #endif
311  /* \brief
312  interpolates the non-corner point values of an element
313  from the corner values
314  */
315  void interpolateFromCorners(escript::Data& out) const;
316 
317  void populateSampleIds();
318 
319  template<typename ValueType>
320  void readBinaryGridImpl(escript::Data& out, const std::string& filename,
321  const ReaderParameters& params) const;
322 
323 #ifdef ESYS_HAVE_BOOST_IO
324  template<typename ValueType>
325  void readBinaryGridZippedImpl(escript::Data& out,
326  const std::string& filename, const ReaderParameters& params) const;
327 #endif
328 
329  template<typename ValueType>
330  void writeBinaryGridImpl(const escript::Data& in,
331  const std::string& filename, int byteOrder) const;
332 
333  dim_t findNode(const double *coords) const;
334 
335 
336  escript::Data randomFillWorker(const escript::DataTypes::ShapeType& shape,
337  long seed, const boost::python::tuple& filter) const;
338 
339 #ifdef ESYS_MPI
340  int neighbour_ranks[8];
342 
344  bool neighbour_exists[8];
345 #endif
346 
348  dim_t m_gNE[3];
349 
351  double m_origin[3];
352 
354  double m_length[3];
355 
357  double m_dx[3];
358 
360  int m_NX[3];
361 
363  dim_t m_NE[3];
364 
366  dim_t m_NN[3];
367 
369  dim_t m_offset[3];
370 
372  dim_t m_faceCount[6];
373 
374 
379 
380  // vector with first node id on each rank
382 
383 #ifdef USE_RIPLEY
384  mutable RipleyCoupler *coupler;
385 #endif
386 };
387 
389 inline dim_t Brick::getDofOfNode(dim_t node) const
390 {
391  return m_nodeId[node];
392 }
393 
395 {
396  return (m_gNE[0]*m_order+1)*(m_gNE[1]*m_order+1)*(m_gNE[2]*m_order+1);
397 }
398 
399 inline double Brick::getLocalCoordinate(index_t index, int dim) const
400 {
401  ESYS_ASSERT(dim>=0 && dim<m_numDim, "'dim' out of bounds");
402  ESYS_ASSERT(index>=0 && index<m_NN[dim], "'index' out of bounds");
403  return m_origin[dim] //origin
404  + m_dx[dim]*(m_offset[dim] + index/m_order //elements
405  + point_locations[m_order-2][index%m_order]); //quads
406 }
407 
408 inline boost::python::tuple Brick::getGridParameters() const
409 {
410  return boost::python::make_tuple(
411  boost::python::make_tuple(m_origin[0], m_origin[1], m_origin[2]),
412  boost::python::make_tuple(m_dx[0], m_dx[1], m_dx[2]),
413  boost::python::make_tuple(m_gNE[0], m_gNE[1], m_gNE[2]));
414 }
415 
416 //protected
417 inline dim_t Brick::getNumDOF() const //global points
418 {
419  return getNumNodes();
420 }
421 
422 //protected
423 inline dim_t Brick::getNumNodes() const //points per rank
424 {
425  return m_NN[0] * m_NN[1] * m_NN[2];
426 }
427 
428 //protected
430 {
431  return m_NE[0]*m_NE[1]*m_NE[2];
432 }
433 
434 } // end of namespace speckley
435 
436 #endif // __Speckley_BRICK_H__
437 
Definition: FunctionSpace.h:34
Definition: AbstractAssembler.cpp:18
SpeckleyDomain extends the AbstractContinuousDomain interface for the Speckley library and is the bas...
Definition: speckley/src/SpeckleyDomain.h:84
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: speckleycpp.cpp:85
bool probeInterpolationAcross(int fsType_source, const escript::AbstractDomain &domain, int fsType_target, int dim)
Definition: CrossDomainCoupler.cpp:31
IndexVector m_elementId
Definition: speckley/src/Brick.h:378
virtual dim_t getDofOfNode(dim_t node) const
Definition: speckley/src/Brick.h:389
IndexVector m_dofId
vector of sample reference identifiers
Definition: speckley/src/Brick.h:376
virtual dim_t getNumDOF() const
returns the number of degrees of freedom per MPI rank
Definition: speckley/src/Brick.h:417
Definition: speckley/src/DefaultAssembler3D.h:31
virtual IndexVector getNodeDistribution() const
returns the node distribution vector
Definition: speckley/src/Brick.h:166
virtual const int * getNumSubdivisionsPerDim() const
returns the number of spatial subdivisions in each dimension
Definition: speckley/src/Brick.h:172
Definition: CrossDomainCoupler.h:28
std::map< std::string, escript::Data > DataMap
Definition: speckley/src/domainhelpers.h:24
virtual dim_t getNumDataPointsGlobal() const
returns the number of data points summed across all MPI processes
Definition: speckley/src/Brick.h:394
std::vector< int > ShapeType
The shape of a single datapoint.
Definition: DataTypes.h:42
#define Speckley_DLL_API
Definition: speckley/src/system_dep.h:22
const double * getLength() const
returns the lengths of the domain
Definition: speckley/src/Brick.h:214
Structure that wraps parameters for the grid reading routines.
Definition: speckley/src/SpeckleyDomain.h:51
int index_t
type for array/matrix indices used both globally and on each rank
Definition: DataTypes.h:59
boost::shared_ptr< SubWorld > SubWorld_ptr
Definition: SubWorld.h:146
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:114
Data represents a collection of datapoints.
Definition: Data.h:63
IndexVector m_nodeDistribution
Definition: speckley/src/Brick.h:381
std::vector< index_t > IndexVector
Definition: Speckley.h:43
virtual dim_t getNumElements() const
returns the number of elements per MPI rank
Definition: speckley/src/Brick.h:429
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:60
std::map< std::string, int > TagMap
Definition: Speckley.h:45
virtual boost::python::tuple getGridParameters() const
returns the tuple (origin, spacing, number_of_elements)
Definition: speckley/src/Brick.h:408
Brick is the 3-dimensional implementation of a SpeckleyDomain.
Definition: speckley/src/Brick.h:32
const double point_locations[][11]
Definition: Speckley.h:60
Definition: speckley/src/WaveAssembler3D.h:31
virtual dim_t getNumNodes() const
returns the number of nodes per MPI rank
Definition: speckley/src/Brick.h:423
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/Brick.h:399
Base class for all escript domains.
Definition: AbstractDomain.h:45
#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
virtual const dim_t * getNumNodesPerDim() const
returns the number of nodes per MPI rank in each dimension
Definition: speckley/src/Brick.h:147
IndexVector m_nodeId
Definition: speckley/src/Brick.h:377
virtual const dim_t * getNumFacesPerBoundary() const
returns the number of face elements in the order (left,right,bottom,top,front,back) on current MPI ra...
Definition: speckley/src/Brick.h:160
index_t dim_t
Definition: DataTypes.h:64
virtual const dim_t * getNumElementsPerDim() const
returns the number of elements per MPI rank in each dimension
Definition: speckley/src/Brick.h:153