escript  Revision_
speckley/src/Brick.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 __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 #ifdef USE_BOOSTIO
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,
194  long seed,
195  const boost::python::tuple& filter) const;
196 
202  virtual void interpolateAcross(escript::Data& target,
203  const escript::Data& source) const;
204 
209  virtual bool probeInterpolationAcross(int, const escript::AbstractDomain&,
210  int) const;
211 
216  const double *getLength() const { return m_length; }
217 
218 protected:
219  virtual dim_t getNumNodes() const;
220  virtual dim_t getNumElements() const;
221  virtual dim_t getNumDOF() const;
222  virtual void assembleCoordinates(escript::Data& arg) const;
223  virtual void assembleGradient(escript::Data& out,
224  const escript::Data& in) const;
225  virtual void assembleIntegrate(DoubleVector& 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  void gradient_order2(escript::Data&, const escript::Data&) const;
241  void gradient_order3(escript::Data&, const escript::Data&) const;
242  void gradient_order4(escript::Data&, const escript::Data&) const;
243  void gradient_order5(escript::Data&, const escript::Data&) const;
244  void gradient_order6(escript::Data&, const escript::Data&) const;
245  void gradient_order7(escript::Data&, const escript::Data&) const;
246  void gradient_order8(escript::Data&, const escript::Data&) const;
247  void gradient_order9(escript::Data&, const escript::Data&) const;
248  void gradient_order10(escript::Data&, const escript::Data&) const;
249 
250  void reduction_order2(const escript::Data&, escript::Data&) const;
251  void reduction_order3(const escript::Data&, escript::Data&) const;
252  void reduction_order4(const escript::Data&, escript::Data&) const;
253  void reduction_order5(const escript::Data&, escript::Data&) const;
254  void reduction_order6(const escript::Data&, escript::Data&) const;
255  void reduction_order7(const escript::Data&, escript::Data&) const;
256  void reduction_order8(const escript::Data&, escript::Data&) const;
257  void reduction_order9(const escript::Data&, escript::Data&) const;
258  void reduction_order10(const escript::Data&, escript::Data&) const;
259 
260  void integral_order2(std::vector<double>&, const escript::Data&) const;
261  void integral_order3(std::vector<double>&, const escript::Data&) const;
262  void integral_order4(std::vector<double>&, const escript::Data&) const;
263  void integral_order5(std::vector<double>&, const escript::Data&) const;
264  void integral_order6(std::vector<double>&, const escript::Data&) const;
265  void integral_order7(std::vector<double>&, const escript::Data&) const;
266  void integral_order8(std::vector<double>&, const escript::Data&) const;
267  void integral_order9(std::vector<double>&, const escript::Data&) const;
268  void integral_order10(std::vector<double>&, const escript::Data&) const;
269 #ifdef ESYS_MPI
270  void setCornerNeighbours();
271  void shareEdges(escript::Data& out, int rx, int ry, int rz) const;
272  void shareFaces(escript::Data& out, int rx, int ry, int rz) const;
273  void shareCorners(escript::Data& out) const;
274 #endif
275  /* \brief
276  interpolates the non-corner point values of an element
277  from the corner values
278  */
279  void interpolateFromCorners(escript::Data& out) const;
280 
281  void populateSampleIds();
282  void addToMatrixAndRHS(escript::AbstractSystemMatrix* S, escript::Data& F,
283  const DoubleVector& EM_S, const DoubleVector& EM_F,
284  bool addS, bool addF, index_t firstNode, int nEq=1, int nComp=1) const;
285 
286  template<typename ValueType>
287  void readBinaryGridImpl(escript::Data& out, const std::string& filename,
288  const ReaderParameters& params) const;
289  template<typename ValueType>
290  void readBinaryGridZippedImpl(escript::Data& out,
291  const std::string& filename, const ReaderParameters& params) const;
292 
293  template<typename ValueType>
294  void writeBinaryGridImpl(const escript::Data& in,
295  const std::string& filename, int byteOrder) const;
296 
297  dim_t findNode(const double *coords) const;
298 
299 
300  escript::Data randomFillWorker(const escript::DataTypes::ShapeType& shape,
301  long seed, const boost::python::tuple& filter) const;
302 
303 #ifdef ESYS_MPI
304  int neighbour_ranks[8];
306 
308  bool neighbour_exists[8];
309 #endif
310 
312  dim_t m_gNE[3];
313 
315  double m_origin[3];
316 
318  double m_length[3];
319 
321  double m_dx[3];
322 
324  int m_NX[3];
325 
327  dim_t m_NE[3];
328 
330  dim_t m_NN[3];
331 
333  dim_t m_offset[3];
334 
336  dim_t m_faceCount[6];
337 
338 
343 
344  // vector with first node id on each rank
346 
347 #ifdef USE_RIPLEY
348  mutable RipleyCoupler *coupler;
349 #endif
350 };
351 
353 inline dim_t Brick::getDofOfNode(dim_t node) const
354 {
355  return m_nodeId[node];
356 }
357 
359 {
360  return (m_gNE[0]*m_order+1)*(m_gNE[1]*m_order+1)*(m_gNE[2]*m_order+1);
361 }
362 
363 inline double Brick::getLocalCoordinate(index_t index, int dim) const
364 {
365  EsysAssert((dim>=0 && dim<m_numDim), "'dim' out of bounds");
366  EsysAssert((index>=0 && index<m_NN[dim]), "'index' out of bounds");
367  return m_origin[dim] //origin
368  + m_dx[dim]*(m_offset[dim] + index/m_order //elements
369  + point_locations[m_order-2][index%m_order]); //quads
370 }
371 
372 inline boost::python::tuple Brick::getGridParameters() const
373 {
374  return boost::python::make_tuple(
375  boost::python::make_tuple(m_origin[0], m_origin[1], m_origin[2]),
376  boost::python::make_tuple(m_dx[0], m_dx[1], m_dx[2]),
377  boost::python::make_tuple(m_gNE[0], m_gNE[1], m_gNE[2]));
378 }
379 
380 //protected
381 inline dim_t Brick::getNumDOF() const //global points
382 {
383  return getNumNodes();
384 }
385 
386 //protected
387 inline dim_t Brick::getNumNodes() const //points per rank
388 {
389  return m_NN[0] * m_NN[1] * m_NN[2];
390 }
391 
392 //protected
394 {
395  return m_NE[0]*m_NE[1]*m_NE[2];
396 }
397 
398 } // end of namespace speckley
399 
400 #endif // __Speckley_BRICK_H__
401 
Definition: FunctionSpace.h:34
Definition: AbstractAssembler.cpp:22
const double * getLength() const
returns the lengths of the domain
Definition: speckley/src/Brick.h:216
SpeckleyDomain extends the AbstractContinuousDomain interface for the Speckley library and is the bas...
Definition: speckley/src/SpeckleyDomain.h:84
bool probeInterpolationAcross(int fsType_source, const escript::AbstractDomain &domain, int fsType_target, int dim)
Definition: CrossDomainCoupler.cpp:36
IndexVector m_elementId
Definition: speckley/src/Brick.h:342
virtual dim_t getNumDOF() const
returns the number of degrees of freedom per MPI rank
Definition: speckley/src/Brick.h:381
IndexVector m_dofId
vector of sample reference identifiers
Definition: speckley/src/Brick.h:340
virtual dim_t getDofOfNode(dim_t node) const
Definition: speckley/src/Brick.h:353
virtual const int * getNumSubdivisionsPerDim() const
returns the number of spatial subdivisions in each dimension
Definition: speckley/src/Brick.h:174
Definition: speckley/src/DefaultAssembler3D.h:29
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:363
Definition: CrossDomainCoupler.h:27
std::map< std::string, escript::Data > DataMap
Definition: speckley/src/domainhelpers.h:24
std::vector< double > DoubleVector
Definition: Speckley.h:39
std::vector< int > ShapeType
The shape of a single datapoint.
Definition: DataTypes.h:38
#define Speckley_DLL_API
Definition: speckley/src/system_dep.h:22
Structure that wraps parameters for the grid reading routines.
Definition: speckley/src/SpeckleyDomain.h:51
virtual dim_t getNumElements() const
returns the number of elements per MPI rank
Definition: speckley/src/Brick.h:393
boost::shared_ptr< SubWorld > SubWorld_ptr
Definition: SubWorld.h:142
virtual boost::python::tuple getGridParameters() const
returns the tuple (origin, spacing, number_of_elements)
Definition: speckley/src/Brick.h:372
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:116
Data represents a collection of datapoints.
Definition: Data.h:68
IndexVector m_nodeDistribution
Definition: speckley/src/Brick.h:345
std::vector< index_t > IndexVector
Definition: Speckley.h:38
#define EsysAssert(AssertTest, AssertMessage)
EsysAssert is a MACRO that will throw an exception if the boolean condition specified is false...
Definition: EsysAssert.h:96
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: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: speckleycpp.cpp:64
int index_t
Definition: types.h:24
std::map< std::string, int > TagMap
Definition: Speckley.h:41
index_t dim_t
Definition: types.h:27
virtual const dim_t * getNumNodesPerDim() const
returns the number of nodes per MPI rank in each dimension
Definition: speckley/src/Brick.h:149
Brick is the 3-dimensional implementation of a SpeckleyDomain.
Definition: speckley/src/Brick.h:32
virtual dim_t getNumDataPointsGlobal() const
returns the number of data points summed across all MPI processes
Definition: speckley/src/Brick.h:358
Base class for escript system matrices.
Definition: AbstractSystemMatrix.h:37
const double point_locations[][11]
Definition: Speckley.h:56
Definition: speckley/src/WaveAssembler3D.h:29
Base class for all escript domains.
Definition: AbstractDomain.h:45
virtual const dim_t * getNumElementsPerDim() const
returns the number of elements per MPI rank in each dimension
Definition: speckley/src/Brick.h:155
IndexVector m_nodeId
Definition: speckley/src/Brick.h:341
virtual IndexVector getNodeDistribution() const
returns the node distribution vector
Definition: speckley/src/Brick.h:168
#define S(_J_, _I_)
Definition: ShapeFunctions.cpp:121
virtual dim_t getNumNodes() const
returns the number of nodes per MPI rank
Definition: speckley/src/Brick.h:387