escript  Revision_
NullDomain.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 __ESCRIPT_NULLDOMAIN_H__
18 #define __ESCRIPT_NULLDOMAIN_H__
19 
20 #include "system_dep.h"
21 #include "AbstractDomain.h"
22 
23 namespace escript {
24 
40 {
41 private:
42  static int NullDomainFS;
44 
45 public:
47 
48  virtual JMPI getMPI() const;
49  virtual int getMPISize() const { return 1; }
50  virtual int getMPIRank() const { return 0; }
51  virtual void MPIBarrier() const {}
52  virtual bool onMasterProcessor() const { return true; }
53  virtual MPI_Comm getMPIComm() const { return MPI_COMM_WORLD; }
54 
55  virtual bool isValidFunctionSpaceType(int fsCode) const {
56  return fsCode==NullDomainFS;
57  }
58 
59  virtual std::string getDescription() const;
60 
61  virtual std::string functionSpaceTypeAsString(int functionSpaceType) const;
62 
63  virtual void interpolateOnDomain(escript::Data& target,const escript::Data& source) const;
64 
65  virtual bool probeInterpolationOnDomain(int functionSpaceType_source,int functionSpaceType_target) const;
66 
67  virtual void interpolateAcross(escript::Data& target, const escript::Data& source) const;
68 
69  virtual bool probeInterpolationAcross(int, const AbstractDomain&, int) const {
70  return false;
71  }
72 
73  virtual int getContinuousFunctionCode() const { return NullDomainFS; }
74  virtual int getFunctionCode() const { return NullDomainFS; }
75  virtual int getFunctionOnBoundaryCode() const { return NullDomainFS; }
76  virtual int getFunctionOnContactZeroCode() const { return NullDomainFS; }
77  virtual int getFunctionOnContactOneCode() const { return NullDomainFS; }
78  virtual int getSolutionCode() const { return NullDomainFS; }
79  virtual int getReducedSolutionCode() const { return NullDomainFS; }
80  virtual int getDiracDeltaFunctionsCode() const { return NullDomainFS; }
81 
82  virtual std::pair<int,DataTypes::dim_t> getDataShape(int functionSpaceCode) const;
83 
84  virtual int getTagFromSampleNo(int, DataTypes::index_t) const { return 1; }
85 
86  virtual const DataTypes::dim_t* borrowSampleReferenceIDs(int) const { return &referenceID; }
87 
88  virtual int getDim() const { return 1; }
89 
90  virtual bool operator==(const AbstractDomain& other) const;
91 
92  virtual bool operator!=(const AbstractDomain& other) const {
93  return !(*this==other);
94  }
95 
96  virtual void write(const std::string& filename) const;
97 
98  virtual void dump(const std::string& filename) const;
99 
100  virtual void setTagMap(const std::string& name, int tag);
101 
102  virtual int getTag(const std::string& name) const;
103 
104  virtual bool canTag(int) const { return true; }
105 
106  virtual std::string showTagNames() const;
107 
108  virtual int getNumberOfTagsInUse(int) const { return 1; }
109 
110  virtual const int* borrowListOfTagsInUse(int functionSpaceCode) const;
111 
112  virtual void setTags(int functionSpaceType, int newTag, const escript::Data& mask) const;
113 
114  bool supportsContactElements() const { return false; }
115 
116  virtual void setNewX(const escript::Data& arg);
117 
118  virtual signed char preferredInterpolationOnDomain(
119  int functionSpaceType_source,
120  int functionSpaceType_target) const;
121 
122  virtual bool commonFunctionSpace(const std::vector<int>& fs,
123  int& resultcode) const;
124  virtual bool isCellOriented(int functionSpaceCode) const;
125  virtual int getApproximationOrder(const int functionSpaceCode) const;
126 
127  virtual escript::Data getX() const;
128  virtual escript::Data getNormal() const;
129  virtual escript::Data getSize() const;
130  virtual void setToX(escript::Data& out) const;
131  virtual void setToNormal(escript::Data& out) const;
132  virtual void setToSize(escript::Data& out) const;
133  virtual void setToGradient(escript::Data& grad, const escript::Data& arg) const;
134  virtual bool ownSample(int fs_code, DataTypes::index_t id) const;
135  virtual escript::Data randomFill(const DataTypes::ShapeType& shape,
136  const FunctionSpace& what, long seed,
137  const boost::python::tuple& filter) const;
138 };
139 
140 } // end of namespace
141 
142 #endif // __ESCRIPT_NULLDOMAIN_H__
143 
Definition: FunctionSpace.h:34
virtual int getDiracDeltaFunctionsCode() const
Definition: NullDomain.h:80
NullDomain provides a null value for domain. Needed for the construction of a default FunctionSpace...
Definition: NullDomain.h:39
virtual int getSolutionCode() const
Definition: NullDomain.h:78
Definition: AbstractContinuousDomain.cpp:22
virtual int getFunctionCode() const
Definition: NullDomain.h:74
virtual void MPIBarrier() const
If compiled for MPI then execute an MPI_Barrier, else do nothing.
Definition: NullDomain.h:51
virtual int getTagFromSampleNo(int, DataTypes::index_t) const
Return the tag key for the given sample number.
Definition: NullDomain.h:84
boost::shared_ptr< JMPI_ > JMPI
Definition: EsysMPI.h:71
virtual int getNumberOfTagsInUse(int) const
returns the number of tags in use and a pointer to an array with the number of tags in use ...
Definition: NullDomain.h:108
virtual int getReducedSolutionCode() const
Definition: NullDomain.h:79
std::vector< int > ShapeType
The shape of a single datapoint.
Definition: DataTypes.h:42
virtual int getMPIRank() const
return the number MPI rank of this processor
Definition: NullDomain.h:50
virtual const DataTypes::dim_t * borrowSampleReferenceIDs(int) const
Returns a borrowed pointer to the sample reference number id list.
Definition: NullDomain.h:86
bool supportsContactElements() const
Definition: NullDomain.h:114
virtual int getContinuousFunctionCode() const
Definition: NullDomain.h:73
#define MPI_COMM_WORLD
Definition: EsysMPI.h:47
int index_t
type for array/matrix indices used both globally and on each rank
Definition: DataTypes.h:59
virtual int getFunctionOnContactZeroCode() const
Definition: NullDomain.h:76
virtual int getDim() const
Returns the spatial dimension of the domain.
Definition: NullDomain.h:88
virtual bool isValidFunctionSpaceType(int fsCode) const
Returns true if the given integer is a valid function space type for this domain. ...
Definition: NullDomain.h:55
virtual bool onMasterProcessor() const
Return true if on MPI master, else false.
Definition: NullDomain.h:52
Data represents a collection of datapoints.
Definition: Data.h:63
virtual int getMPISize() const
return the number of processors used for this domain
Definition: NullDomain.h:49
int getTag(unsigned char sourcex, unsigned char sourcey, unsigned char sourcez, unsigned char targetx, unsigned char targety, unsigned char targetz)
Definition: blocktools.cpp:412
static DataTypes::dim_t referenceID
Definition: NullDomain.h:43
virtual bool probeInterpolationAcross(int, const AbstractDomain &, int) const
Definition: NullDomain.h:69
static int NullDomainFS
Definition: NullDomain.h:42
int MPI_Comm
Definition: EsysMPI.h:41
virtual int getFunctionOnContactOneCode() const
Definition: NullDomain.h:77
virtual int getFunctionOnBoundaryCode() const
Definition: NullDomain.h:75
#define ESCRIPT_DLL_API
Definition: escriptcore/src/system_dep.h:29
virtual bool canTag(int) const
Checks if this domain allows tags for the specified functionSpaceCode.
Definition: NullDomain.h:104
Base class for all escript domains.
Definition: AbstractDomain.h:45
virtual bool operator!=(const AbstractDomain &other) const
Return true if given domains are not equal.
Definition: NullDomain.h:92
virtual MPI_Comm getMPIComm() const
get the communicator for this domain. Returns an integer on non-MPI builds Routine must be implemente...
Definition: NullDomain.h:53
index_t dim_t
Definition: DataTypes.h:64
NullDomain()
Definition: NullDomain.h:46