escript  Revision_4925
AbstractDomain.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 
18 #if !defined escript_AbstractDomain_20040609_H
19 #define escript_AbstractDomain_20040609_H
20 
21 #ifdef BADPYTHONMACROS
22 // This hack is required for BSD/OSX builds with python 2.7
23 // (and possibly others). It must be the first include.
24 // From bug reports online it seems that python redefines
25 // some c macros that are functions in c++.
26 // c++ doesn't like that!
27 #include <Python.h>
28 #undef BADPYTHONMACROS
29 #endif
30 
31 
32 #include "system_dep.h"
33 
34 #include <vector>
35 #include <string>
36 #include <map>
37 #include <boost/python/dict.hpp>
38 #include <boost/python/list.hpp>
39 #include "esysUtils/Esys_MPI.h"
40 
41 
42 #include "Pointers.h"
43 #include "DataTypes.h"
44 
45 namespace escript {
46 // class forward declarations
47 class Data;
48 class FunctionSpace;
58 
61 
63 
64  public:
65 
73  Domain_ptr getPtr();
75  const_Domain_ptr getPtr() const;
76 
77  // structure holding values for X, size and normal
78  typedef int StatusType;
79  struct ValueBuffer
80  {
81  StatusType m_status;
82  boost::shared_ptr<Data> m_data;
83  };
84  typedef struct ValueBuffer ValueBuffer;
85 
86  //
87  // map from function space type code to value buffer
88  typedef std::map<int, ValueBuffer> BufferMapType;
89 
90 
112  AbstractDomain();
113 
122  virtual ~AbstractDomain();
123 
129  virtual int getMPISize() const;
136  virtual int getMPIRank() const;
137 
144  virtual void MPIBarrier() const;
151  virtual bool onMasterProcessor() const;
152 
159  virtual
160 #ifdef ESYS_MPI
161  MPI_Comm
162 #else
163  unsigned int
164 #endif
165  getMPIComm() const;
166 
173  virtual bool isValidFunctionSpaceType(int functionSpaceType) const;
174 
180  virtual std::string getDescription() const;
181 
187  virtual std::string functionSpaceTypeAsString(int functionSpaceType) const;
188 
196  virtual int getDim() const;
197 
203  virtual bool operator==(const AbstractDomain& other) const;
205  virtual bool operator!=(const AbstractDomain& other) const;
206 
214  virtual void write(const std::string& filename) const;
215 
223  virtual void dump(const std::string& filename) const;
224 
235  virtual std::pair<int,int> getDataShape(int functionSpaceCode) const;
236 
244  virtual int getTagFromSampleNo(int functionSpaceType, int sampleNo) const;
245 
253  virtual void setTagMap(const std::string& name, int tag);
254 
261  virtual int getTag(const std::string& name) const;
262 
269  virtual bool isValidTagName(const std::string& name) const;
270 
276  virtual std::string showTagNames() const;
277 
284  virtual const int* borrowSampleReferenceIDs(int functionSpaceType) const;
285 
293  virtual void setNewX(const escript::Data& arg);
294 
302  virtual void interpolateOnDomain(escript::Data& target,const escript::Data& source) const;
303 
308  virtual bool probeInterpolationOnDomain(int functionSpaceType_source,int functionSpaceType_target) const;
309 
317  virtual signed char preferredInterpolationOnDomain(int functionSpaceType_source,int functionSpaceType_target) const;
318 
325  virtual
326  bool
327  commonFunctionSpace(const std::vector<int>& fs, int& resultcode) const;
328 
336  virtual void interpolateACross(escript::Data& target, const escript::Data& source) const;
338  virtual bool probeInterpolationACross(int functionSpaceType_source,const AbstractDomain& targetDomain, int functionSpaceType_target) const;
339 
345  virtual escript::Data getX() const;
346 
352  virtual escript::Data getNormal() const;
353 
359  virtual escript::Data getSize() const;
360 
370  virtual void setToX(escript::Data& out) const;
371 
381  virtual void setToNormal(escript::Data& out) const;
382 
392  virtual void setToSize(escript::Data& out) const;
393 
402  virtual void setToGradient(escript::Data& grad, const escript::Data& arg) const;
403 
409  virtual bool ownSample(int fs_code, index_t id) const;
410 
417  virtual void setTags(const int functionSpaceType, const int newTag, const escript::Data& mask) const;
418 
427  virtual bool isCellOriented(int functionSpaceCode) const;
428 
438  virtual StatusType getStatus() const;
439 
446  void throwStandardException(const std::string& functionName) const;
447 
453  virtual int getNumberOfTagsInUse(int functionSpaceCode) const;
454 
456  virtual const int* borrowListOfTagsInUse(int functionSpaceCode) const;
457 
462  virtual bool canTag(int functionspacecode) const;
463 
469  virtual int getApproximationOrder(const int functionSpaceCode) const;
470 
472  virtual bool supportsContactElements() const;
473 
474 
475 
480  virtual bool supportsFilter(const boost::python::tuple& t) const;
481 
486  virtual escript::Data randomFill(const DataTypes::ShapeType& shape,
487  const FunctionSpace& what, long seed, const boost::python::tuple& filter) const=0;
488 
489  protected:
490 
491  private:
492 
493  // buffer for coordinates used by function spaces
494  BufferMapType m_x_buffer;
495 
496  // buffer for normal vectors used by function spaces
497  BufferMapType m_normal_buffer;
498 
499  // buffer for normal element size used by function spaces
500  BufferMapType m_size_buffer;
501 
502 };
503 
504 } // end of namespace
505 
506 #endif
Give a short description of what FunctionSpace does.
Definition: FunctionSpace.h:46
boost::shared_ptr< Data > m_data
Definition: AbstractDomain.h:82
#define POINTER_WRAPPER_CLASS(x)
Definition: Pointers.h:32
Definition: AbstractDomain.h:79
boost::shared_ptr< AbstractDomain > Domain_ptr
Definition: AbstractDomain.h:57
BufferMapType m_normal_buffer
Definition: AbstractDomain.h:497
#define REFCOUNT_BASE_CLASS(x)
Definition: Pointers.h:29
std::vector< int > ShapeType
The shape of a single datapoint.
Definition: DataTypes.h:38
int MPI_Comm
Definition: Esys_MPI.h:29
std::map< int, ValueBuffer > BufferMapType
Definition: AbstractDomain.h:88
Typedefs and macros for reference counted storage.
BufferMapType m_x_buffer
Definition: AbstractDomain.h:494
int StatusType
Definition: AbstractDomain.h:78
Data represents a collection of datapoints.
Definition: Data.h:71
int getTag(unsigned char sourcex, unsigned char sourcey, unsigned char sourcez, unsigned char targetx, unsigned char targety, unsigned char targetz)
Definition: blocktools.cpp:411
StatusType m_status
Definition: AbstractDomain.h:81
int index_t
Definition: types.h:25
#define ESCRIPT_DLL_API
Definition: escriptcore/src/system_dep.h:64
Definition: AbstractDomain.h:62
BufferMapType m_size_buffer
Definition: AbstractDomain.h:500
boost::shared_ptr< const AbstractDomain > const_Domain_ptr
Definition: AbstractDomain.h:60