Go to the documentation of this file.
18 #ifndef __ESCRIPT_NULLDOMAIN_H__
19 #define __ESCRIPT_NULLDOMAIN_H__
49 virtual JMPI getMPI()
const;
57 return fsCode==NullDomainFS;
60 virtual std::string getDescription()
const;
62 virtual std::string functionSpaceTypeAsString(
int functionSpaceType)
const;
66 virtual bool probeInterpolationOnDomain(
int functionSpaceType_source,
int functionSpaceType_target)
const;
83 virtual std::pair<int,DataTypes::dim_t> getDataShape(
int functionSpaceCode)
const;
89 virtual int getDim()
const {
return 1; }
94 return !(*
this==other);
97 virtual void write(
const std::string& filename)
const;
99 virtual void dump(
const std::string& filename)
const;
101 virtual void setTagMap(
const std::string& name,
int tag);
103 virtual int getTag(
const std::string& name)
const;
105 virtual bool canTag(
int)
const {
return true; }
107 virtual std::string showTagNames()
const;
111 virtual const int* borrowListOfTagsInUse(
int functionSpaceCode)
const;
113 virtual void setTags(
int functionSpaceType,
int newTag,
const escript::Data& mask)
const;
119 virtual signed char preferredInterpolationOnDomain(
120 int functionSpaceType_source,
121 int functionSpaceType_target)
const;
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;
129 #ifdef ESYS_HAVE_BOOST_NUMPY
130 virtual boost::python::numpy::ndarray getNumpyX()
const;
141 const boost::python::tuple& filter)
const;
146 #endif // __ESCRIPT_NULLDOMAIN_H__
virtual int getFunctionOnContactOneCode() const
Definition: NullDomain.h:78
#define ESCRIPT_DLL_API
Definition: escriptcore/src/system_dep.h:30
virtual bool onMasterProcessor() const
Return true if on MPI master, else false.
Definition: NullDomain.h:53
virtual bool probeInterpolationOnDomain(int functionSpaceType_source, int functionSpaceType_target) const
True if interpolation is possible from source to target.
Definition: NullDomain.cpp:57
virtual std::string getDescription() const
Return a description for this domain.
Definition: NullDomain.cpp:33
virtual int getContinuousFunctionCode() const
Definition: NullDomain.h:74
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:128
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
NullDomain provides a null value for domain. Needed for the construction of a default FunctionSpace.
Definition: NullDomain.h:41
Definition: DomainException.h:28
virtual int getSolutionCode() const
Definition: NullDomain.h:79
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:43
virtual bool operator!=(const AbstractDomain &other) const
Return true if given domains are not equal.
Definition: NullDomain.h:93
virtual int getReducedSolutionCode() const
Definition: NullDomain.h:80
virtual escript::Data getNormal() const
Return boundary normals. The function space is chosen appropriately.
Definition: NullDomain.cpp:155
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
virtual void write(const std::string &filename) const
Writes the domain to an external file filename.
Definition: NullDomain.cpp:104
bool supportsContactElements() const
Definition: NullDomain.h:115
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:164
virtual int getMPISize() const
return the number of processors used for this domain
Definition: NullDomain.h:50
Definition: FunctionSpace.h:36
const FunctionSpace & getFunctionSpace() const
Return the function space.
Definition: Data.h:463
virtual const int * borrowListOfTagsInUse(int functionSpaceCode) const
Definition: NullDomain.cpp:90
const_Domain_ptr getDomain() const
Returns the function space domain.
Definition: FunctionSpace.cpp:103
bool initialize(const std::string &simFile, const std::string &comment)
Definition: VisItControl.cpp:178
virtual int getDim() const
Returns the spatial dimension of the domain.
Definition: NullDomain.h:89
#define MPI_COMM_WORLD
Definition: EsysMPI.h:48
Data represents a collection of datapoints.
Definition: Data.h:64
virtual std::string functionSpaceTypeAsString(int functionSpaceType) const
Return a description for the given function space type code.
Definition: NullDomain.cpp:38
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:118
index_t dim_t
Definition: DataTypes.h:65
virtual int getFunctionOnContactZeroCode() const
Definition: NullDomain.h:77
std::vector< int > ShapeType
The shape of a single datapoint.
Definition: DataTypes.h:43
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:71
virtual bool canTag(int) const
Checks if this domain allows tags for the specified functionSpaceCode.
Definition: NullDomain.h:105
boost::shared_ptr< JMPI_ > JMPI
Definition: EsysMPI.h:72
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
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:95
virtual int getFunctionCode() const
Definition: NullDomain.h:75
virtual escript::Data getSize() const
Returns the local size of samples. The function space is chosen appropriately.
Definition: NullDomain.cpp:168
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:193
virtual void dump(const std::string &filename) const
dumps the domain to an external file filename.
Definition: NullDomain.cpp:100
virtual void setTagMap(const std::string &name, int tag)
sets a map from a clear tag name to a tag key
Definition: NullDomain.cpp:143
NullDomain()
Definition: NullDomain.h:47
virtual void setNewX(const escript::Data &arg)
Assigns new location to the domain.
Definition: NullDomain.cpp:151
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:160
virtual void MPIBarrier() const
If compiled for MPI then execute an MPI_Barrier, else do nothing.
Definition: NullDomain.h:52
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:147
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:113
virtual int getFunctionOnBoundaryCode() const
Definition: NullDomain.h:76
static DataTypes::dim_t referenceID
Definition: NullDomain.h:44
virtual int getTag(const std::string &name) const
Return the tag key for tag name.
Definition: NullDomain.cpp:138
int index_t
type for array/matrix indices used both globally and on each rank
Definition: DataTypes.h:60
virtual std::string showTagNames() const
Returns all tag names in a single string sperated by commas.
Definition: NullDomain.cpp:133
virtual int getTagFromSampleNo(int, DataTypes::index_t) const
Return the tag key for the given sample number.
Definition: NullDomain.h:85
Definition: AbstractContinuousDomain.cpp:23
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:108
virtual bool probeInterpolationAcross(int, const AbstractDomain &, int) const
Definition: NullDomain.h:70
virtual int getDiracDeltaFunctionsCode() const
Definition: NullDomain.h:81
virtual escript::Data getX() const
Returns locations in the domain. The function space is chosen appropriately.
Definition: NullDomain.cpp:177
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:66
int MPI_Comm
Definition: EsysMPI.h:42
virtual int getMPIRank() const
return the number MPI rank of this processor
Definition: NullDomain.h:51
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:173
Base class for all escript domains.
Definition: AbstractDomain.h:51
virtual bool operator==(const AbstractDomain &other) const
Return true if given domains are equal.
Definition: NullDomain.cpp:80
virtual int getApproximationOrder(const int functionSpaceCode) const
returns the approximation order used for a function space functionSpaceCode
Definition: NullDomain.cpp:123
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:48
virtual const DataTypes::dim_t * borrowSampleReferenceIDs(int) const
Returns a borrowed pointer to the sample reference number id list.
Definition: NullDomain.h:87
virtual JMPI getMPI() const
returns a shared pointer to the MPI information wrapper for this domain
Definition: NullDomain.cpp:43
static int NullDomainFS
Definition: NullDomain.h:43