escript  Revision_Unversioneddirectory
ripley/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 __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(dim_t n0, dim_t n1, dim_t n2, double x0, double y0, double z0,
44  double x1, 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 TagMap& tagnamestonums = TagMap(),
49 
54  ~Brick();
55 
60  virtual std::string getDescription() const;
61 
65  virtual bool operator==(const escript::AbstractDomain& other) const;
66 
72  virtual void write(const std::string& filename) const;
73 
79  void dump(const std::string& filename) const;
80 
83  virtual void readNcGrid(escript::Data& out, std::string filename,
84  std::string varname, const ReaderParameters& params) const;
85 
88  virtual void readBinaryGrid(escript::Data& out, std::string filename,
89  const ReaderParameters& params) const;
90 
91 #ifdef USE_BOOSTIO
92  virtual void readBinaryGridFromZipped(escript::Data& out, std::string filename,
93  const ReaderParameters& params) const;
94 #endif
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 
199  const double *getLength() const { return m_length; }
200 
205  const double *getElementLength() const { return m_dx; }
206 
212  virtual RankVector getOwnerVector(int fsType) const;
213 
214 protected:
215  virtual dim_t getNumNodes() const;
216  virtual dim_t getNumElements() const;
217  virtual dim_t getNumFaceElements() const;
218  virtual dim_t getNumDOF() const;
219  virtual IndexVector getDiagonalIndices(bool upperOnly) const;
220  virtual void assembleCoordinates(escript::Data& arg) const;
221  virtual void assembleGradient(escript::Data& out, const escript::Data& in) const;
222  virtual void assembleIntegrate(DoubleVector& integrals, const escript::Data& arg) const;
223  virtual paso::SystemMatrixPattern_ptr getPasoMatrixPattern(
224  bool reducedRowOrder, bool reducedColOrder) const;
225  virtual void interpolateNodesOnElements(escript::Data& out,
226  const escript::Data& in, bool reduced) const;
227  virtual void interpolateNodesOnFaces(escript::Data& out,
228  const escript::Data& in,
229  bool reduced) const;
230  virtual void nodesToDOF(escript::Data& out, const escript::Data& in) const;
231  virtual void dofToNodes(escript::Data& out, 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 
235  void populateSampleIds();
236  void populateDofMap();
237  std::vector<IndexVector> getConnections() const;
238  void addToMatrixAndRHS(escript::AbstractSystemMatrix* S, escript::Data& F,
239  const DoubleVector& EM_S, const DoubleVector& EM_F,
240  bool addS, bool addF, index_t firstNode, int nEq=1, int nComp=1) const;
241 
242  template<typename ValueType>
243  void readBinaryGridImpl(escript::Data& out, const std::string& filename,
244  const ReaderParameters& params) const;
245  template<typename ValueType>
246  void readBinaryGridZippedImpl(escript::Data& out, const std::string& filename,
247  const ReaderParameters& params) const;
248  template<typename ValueType>
249  void writeBinaryGridImpl(const escript::Data& in,
250  const std::string& filename, int byteOrder) const;
251 
252  dim_t findNode(const double *coords) const;
253 
254  virtual escript::Data randomFillWorker(
255  const escript::DataTypes::ShapeType& shape, long seed,
256  const boost::python::tuple& filter) const;
257 
259  dim_t m_gNE[3];
260 
262  double m_origin[3];
263 
265  double m_length[3];
266 
268  double m_dx[3];
269 
271  int m_NX[3];
272 
274  dim_t m_NE[3];
275 
277  dim_t m_ownNE[3];
278 
280  dim_t m_NN[3];
281 
283  dim_t m_offset[3];
284 
286  dim_t m_faceCount[6];
287 
292 
298 
299  // vector with first node id on each rank
301 
302  // vector that maps each node to a DOF index (used for the coupler)
304 
305  // Paso connector used by the system matrix and to interpolate DOF to
306  // nodes
308 
309  // the Paso System Matrix pattern
311 };
312 
314 inline dim_t Brick::getDofOfNode(dim_t node) const
315 {
316  return m_dofMap[node];
317 }
318 
320 {
321  return (m_gNE[0]+1)*(m_gNE[1]+1)*(m_gNE[2]+1);
322 }
323 
324 inline double Brick::getLocalCoordinate(index_t index, int dim) const
325 {
326  EsysAssert((dim>=0 && dim<3), "'dim' out of bounds");
327  EsysAssert((index>=0 && index<m_NN[dim]), "'index' out of bounds");
328  return m_origin[dim]+m_dx[dim]*(m_offset[dim]+index);
329 }
330 
331 inline boost::python::tuple Brick::getGridParameters() const
332 {
333  return boost::python::make_tuple(
334  boost::python::make_tuple(m_origin[0], m_origin[1], m_origin[2]),
335  boost::python::make_tuple(m_dx[0], m_dx[1], m_dx[2]),
336  boost::python::make_tuple(m_gNE[0], m_gNE[1], m_gNE[2]));
337 }
338 
339 //protected
340 inline dim_t Brick::getNumDOF() const
341 {
342  return (m_gNE[0]+1)/m_NX[0]*(m_gNE[1]+1)/m_NX[1]*(m_gNE[2]+1)/m_NX[2];
343 }
344 
345 //protected
346 inline dim_t Brick::getNumNodes() const
347 {
348  return m_NN[0]*m_NN[1]*m_NN[2];
349 }
350 
351 //protected
353 {
354  return m_NE[0]*m_NE[1]*m_NE[2];
355 }
356 
357 //protected
359 {
360  return m_faceCount[0] + m_faceCount[1] + m_faceCount[2]
361  + m_faceCount[3] + m_faceCount[4] + m_faceCount[5];
362 }
363 
364 } // end of namespace ripley
365 
366 #endif // __RIPLEY_BRICK_H__
367 
virtual const dim_t * getNumNodesPerDim() const
returns the number of nodes per MPI rank in each dimension
Definition: ripley/src/Brick.h:147
Definition: FunctionSpace.h:34
virtual dim_t getDofOfNode(dim_t node) const
Definition: ripley/src/Brick.h:314
const double * getElementLength() const
returns the lengths of an element
Definition: ripley/src/Brick.h:205
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
virtual dim_t getNumFaceElements() const
returns the number of face elements on current MPI rank
Definition: ripley/src/Brick.h:358
virtual dim_t getNumDOF() const
returns the number of degrees of freedom per MPI rank
Definition: ripley/src/Brick.h:340
virtual boost::python::tuple getGridParameters() const
returns the tuple (origin, spacing, number_of_elements)
Definition: ripley/src/Brick.h:331
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: ripley/src/Brick.h:160
virtual const dim_t * getNumElementsPerDim() const
returns the number of elements per MPI rank in each dimension
Definition: ripley/src/Brick.h:153
std::vector< int > ShapeType
The shape of a single datapoint.
Definition: DataTypes.h:38
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
virtual const int * getNumSubdivisionsPerDim() const
returns the number of spatial subdivisions in each dimension
Definition: ripley/src/Brick.h:172
virtual dim_t getNumNodes() const
returns the number of nodes per MPI rank
Definition: ripley/src/Brick.h:346
std::map< std::string, int > TagMap
Definition: Ripley.h:41
IndexVector m_nodeDistribution
Definition: ripley/src/Brick.h:300
std::vector< index_t > IndexVector
Definition: Ripley.h:38
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
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/Brick.h:324
#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 dim_t getNumDataPointsGlobal() const
returns the number of data points summed across all MPI processes
Definition: ripley/src/Brick.h:319
RipleyDomain extends the AbstractContinuousDomain interface for the Ripley library and is the base cl...
Definition: ripley/src/RipleyDomain.h:85
Definition: ripley/src/WaveAssembler3D.h:24
Definition: LameAssembler3D.h:24
virtual IndexVector getNodeDistribution() const
returns the node distribution vector
Definition: ripley/src/Brick.h:166
int index_t
Definition: types.h:24
Brick is the 3-dimensional implementation of a RipleyDomain.
Definition: ripley/src/Brick.h:29
std::vector< Esys_MPI_rank > RankVector
Definition: Ripley.h:40
paso::Connector_ptr m_connector
Definition: ripley/src/Brick.h:307
Definition: ripley/src/DefaultAssembler3D.h:24
boost::shared_ptr< Connector > Connector_ptr
Definition: Coupler.h:35
index_t dim_t
Definition: types.h:27
const double * getLength() const
returns the lengths of the domain
Definition: ripley/src/Brick.h:199
Base class for escript system matrices.
Definition: AbstractSystemMatrix.h:37
IndexVector m_nodeId
Definition: ripley/src/Brick.h:295
IndexVector m_dofId
vector of sample reference identifiers
Definition: ripley/src/Brick.h:294
Definition: ripley/src/AbstractAssembler.h:25
paso::SystemMatrixPattern_ptr m_pattern
Definition: ripley/src/Brick.h:310
Base class for all escript domains.
Definition: AbstractDomain.h:45
#define RIPLEY_DLL_API
Definition: ripley/src/system_dep.h:22
IndexVector m_faceId
Definition: ripley/src/Brick.h:297
virtual dim_t getNumElements() const
returns the number of elements per MPI rank
Definition: ripley/src/Brick.h:352
IndexVector m_elementId
Definition: ripley/src/Brick.h:296
#define S(_J_, _I_)
Definition: ShapeFunctions.cpp:121
std::vector< double > DoubleVector
Definition: Ripley.h:39
IndexVector m_dofMap
Definition: ripley/src/Brick.h:303
IndexVector m_faceOffset
Definition: ripley/src/Brick.h:291