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