escript  Revision_
NullDomain.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 __ESCRIPT_NULLDOMAIN_H__
18 #define __ESCRIPT_NULLDOMAIN_H__
19 
20 #include "system_dep.h"
21 #include "AbstractDomain.h"
22 
23 namespace escript {
24 
39 class ESCRIPT_DLL_API NullDomain : public AbstractDomain
40 {
41 private:
42  static int NullDomainFS;
43  static DataTypes::dim_t referenceID;
44 
45 public:
46  NullDomain() {}
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 
ESCRIPT_DLL_API
#define ESCRIPT_DLL_API
Definition: escriptcore/src/system_dep.h:28
escript::NullDomain::probeInterpolationOnDomain
virtual bool probeInterpolationOnDomain(int functionSpaceType_source, int functionSpaceType_target) const
True if interpolation is possible from source to target.
Definition: NullDomain.cpp:67
escript::NullDomain::getDescription
virtual std::string getDescription() const
Return a description for this domain.
Definition: NullDomain.cpp:43
getTag
int getTag(unsigned char sourcex, unsigned char sourcey, unsigned char sourcez, unsigned char targetx, unsigned char targety, unsigned char targetz)
Definition: blocktools.cpp:412
escript::NullDomain::preferredInterpolationOnDomain
virtual signed char preferredInterpolationOnDomain(int functionSpaceType_source, int functionSpaceType_target) const
Preferred direction of interpolation. If you really need to test for a particular direction,...
Definition: NullDomain.cpp:138
escript::NullDomain
NullDomain provides a null value for domain. Needed for the construction of a default FunctionSpace.
Definition: NullDomain.h:50
escript::DomainException
Definition: DomainException.h:37
escript::AbstractDomain::throwStandardException
void throwStandardException(const std::string &functionName) const
Throw a standard exception. This function is called if any attempt is made to use a base class functi...
Definition: AbstractDomain.cpp:54
escript::NullDomain::getNormal
virtual escript::Data getNormal() const
Return boundary normals. The function space is chosen appropriately.
Definition: NullDomain.cpp:165
escript::NullDomain::write
virtual void write(const std::string &filename) const
Writes the domain to an external file filename.
Definition: NullDomain.cpp:114
escript::NullDomain::setToGradient
virtual void setToGradient(escript::Data &grad, const escript::Data &arg) const
Copies the gradient of arg into grad. The actual function space to be considered for the gradient is ...
Definition: NullDomain.cpp:174
escript::FunctionSpace
Definition: FunctionSpace.h:45
escript::Data::getFunctionSpace
const FunctionSpace & getFunctionSpace() const
Return the function space.
Definition: Data.h:461
escript::NullDomain::borrowListOfTagsInUse
virtual const int * borrowListOfTagsInUse(int functionSpaceCode) const
Definition: NullDomain.cpp:100
speckley::probeInterpolationAcross
bool probeInterpolationAcross(int fsType_source, const escript::AbstractDomain &domain, int fsType_target, int dim)
Definition: CrossDomainCoupler.cpp:30
escript::FunctionSpace::getDomain
const_Domain_ptr getDomain() const
Returns the function space domain.
Definition: FunctionSpace.cpp:101
system_dep.h
MPI_COMM_WORLD
#define MPI_COMM_WORLD
Definition: EsysMPI.h:46
escript::Data
Data represents a collection of datapoints.
Definition: Data.h:62
escript::NullDomain::functionSpaceTypeAsString
virtual std::string functionSpaceTypeAsString(int functionSpaceType) const
Return a description for the given function space type code.
Definition: NullDomain.cpp:48
escript::NullDomain::ownSample
virtual bool ownSample(int fs_code, DataTypes::index_t id) const
True if this rank owns the sample(id) Must be implemented by the Domain adapter.
Definition: NullDomain.cpp:128
escript::DataTypes::dim_t
index_t dim_t
Definition: DataTypes.h:87
escript::DataTypes::ShapeType
std::vector< int > ShapeType
The shape of a single datapoint.
Definition: DataTypes.h:65
escript::NullDomain::getDataShape
virtual std::pair< int, DataTypes::dim_t > getDataShape(int functionSpaceCode) const
Returns the number of data points per sample, and the number of samples as a pair.
Definition: NullDomain.cpp:81
escript::JMPI
boost::shared_ptr< JMPI_ > JMPI
Definition: EsysMPI.h:70
escript::NullDomain::randomFill
virtual escript::Data randomFill(const DataTypes::ShapeType &shape, const FunctionSpace &what, long seed, const boost::python::tuple &filter) const
Fills the data object with filtered random values.
Definition: NullDomain.cpp:105
DomainException.h
escript::NullDomain::getSize
virtual escript::Data getSize() const
Returns the local size of samples. The function space is chosen appropriately.
Definition: NullDomain.cpp:178
AbstractDomain.h
escript::NullDomain::setToX
virtual void setToX(escript::Data &out) const
Copies the location of data points on the domain into out. The actual function space to be considered...
Definition: NullDomain.cpp:192
escript::NullDomain::dump
virtual void dump(const std::string &filename) const
dumps the domain to an external file filename.
Definition: NullDomain.cpp:110
escript::NullDomain::setTagMap
virtual void setTagMap(const std::string &name, int tag)
sets a map from a clear tag name to a tag key
Definition: NullDomain.cpp:153
escript::NullDomain::setNewX
virtual void setNewX(const escript::Data &arg)
Assigns new location to the domain.
Definition: NullDomain.cpp:161
escript::NullDomain::setToNormal
virtual void setToNormal(escript::Data &out) const
Copies the surface normals at data points into out. The actual function space to be considered is def...
Definition: NullDomain.cpp:170
escript::NullDomain::setTags
virtual void setTags(int functionSpaceType, int newTag, const escript::Data &mask) const
assigns new tag newTag to all samples of functionspace with a positive value of mask for any its samp...
Definition: NullDomain.cpp:157
escript::NullDomain::isCellOriented
virtual bool isCellOriented(int functionSpaceCode) const
returns true if data on this domain and a function space of type functionSpaceCode has to considered ...
Definition: NullDomain.cpp:123
escript::NullDomain::referenceID
static DataTypes::dim_t referenceID
Definition: NullDomain.h:66
escript::NullDomain::getTag
virtual int getTag(const std::string &name) const
Return the tag key for tag name.
Definition: NullDomain.cpp:148
escript::DataTypes::index_t
int index_t
type for array/matrix indices used both globally and on each rank
Definition: DataTypes.h:82
escript::NullDomain::showTagNames
virtual std::string showTagNames() const
Returns all tag names in a single string sperated by commas.
Definition: NullDomain.cpp:143
escript
Definition: AbstractContinuousDomain.cpp:22
escript::NullDomain::commonFunctionSpace
virtual bool commonFunctionSpace(const std::vector< int > &fs, int &resultcode) const
given a vector of FunctionSpace type codes, pass back a code which then can all be interpolated to.
Definition: NullDomain.cpp:118
NullDomain.h
escript::NullDomain::getX
virtual escript::Data getX() const
Returns locations in the domain. The function space is chosen appropriately.
Definition: NullDomain.cpp:187
escript::NullDomain::interpolateAcross
virtual void interpolateAcross(escript::Data &target, const escript::Data &source) const
Interpolates data given on source onto target where source and target are given on different domains.
Definition: NullDomain.cpp:76
MPI_Comm
int MPI_Comm
Definition: EsysMPI.h:40
escript::NullDomain::setToSize
virtual void setToSize(escript::Data &out) const
Copies the size of samples into out. The actual function space to be considered is defined by out....
Definition: NullDomain.cpp:183
Data.h
escript::AbstractDomain
Base class for all escript domains.
Definition: AbstractDomain.h:56
escript::NullDomain::operator==
virtual bool operator==(const AbstractDomain &other) const
Return true if given domains are equal.
Definition: NullDomain.cpp:90
escript::NullDomain::getApproximationOrder
virtual int getApproximationOrder(const int functionSpaceCode) const
returns the approximation order used for a function space functionSpaceCode
Definition: NullDomain.cpp:133
escript::NullDomain::interpolateOnDomain
virtual void interpolateOnDomain(escript::Data &target, const escript::Data &source) const
Interpolates data given on source onto target where source and target have to be given on the same do...
Definition: NullDomain.cpp:58
escript::NullDomain::getMPI
virtual JMPI getMPI() const
returns a shared pointer to the MPI information wrapper for this domain
Definition: NullDomain.cpp:53
escript::NullDomain::NullDomainFS
static int NullDomainFS
Definition: NullDomain.h:65