escript  Revision_
TestDomain.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_TESTDOMAIN_H__
19 #define __ESCRIPT_TESTDOMAIN_H__
20 
21 #include "system_dep.h"
22 #include "NullDomain.h"
23 #include <vector>
24 
25 namespace escript {
26 
42 class ESCRIPT_DLL_API TestDomain : public NullDomain
43 {
44 public:
45  TestDomain(int pointspersample, int numsamples, int dpsize=1);
46 
47  virtual ~TestDomain();
48 
49  virtual int getMPISize() const;
50  virtual int getMPIRank() const;
51  virtual void MPIBarrier() const;
52  virtual bool onMasterProcessor() const;
53 
54  virtual escript::JMPI getMPI() const;
55 
56  virtual bool isValidFunctionSpaceType(int functionSpaceType) const;
57 
58  virtual std::string getDescription() const;
59 
60  virtual std::string functionSpaceTypeAsString(int functionSpaceType) const;
61 
62  virtual void interpolateOnDomain(escript::Data& target,const escript::Data& source) const;
63 
64  virtual bool probeInterpolationOnDomain(int functionSpaceType_source,int functionSpaceType_target) const;
65 
66  bool commonFunctionSpace(const std::vector<int>& fs, int& resultcode) const;
67 
68  virtual escript::Data getX() const;
69 
70  virtual void interpolateAcross(escript::Data& target, const escript::Data& source) const;
71 
72  virtual bool probeInterpolationAcross(int functionSpaceType_source,const AbstractDomain& targetDomain, int functionSpaceType_target) const;
73 
74  virtual int getDefaultCode() const;
75  virtual int getContinuousFunctionCode() const;
76  virtual int getFunctionCode() const;
77  virtual int getFunctionOnBoundaryCode() const;
78  virtual int getFunctionOnContactZeroCode() const;
79  virtual int getFunctionOnContactOneCode() const;
80  virtual int getSolutionCode() const;
81  virtual int getReducedSolutionCode() const;
82  virtual int getDiracDeltaFunctionsCode() const;
83 
84  virtual std::pair<int,DataTypes::dim_t> getDataShape(int functionSpaceCode) const;
85 
86  virtual int getTagFromSampleNo(int functionSpaceType, DataTypes::index_t sampleNo) const;
87 
88  virtual const DataTypes::dim_t* borrowSampleReferenceIDs(int functionSpaceType) const;
89 
90  virtual int getDim() const;
91 
92  virtual bool operator==(const AbstractDomain& other) const;
93 
94  virtual bool operator!=(const AbstractDomain& other) const;
95 
96  virtual bool canTag(int functionSpaceCode) const;
97 
98  virtual int getNumberOfTagsInUse(int functionSpaceCode) const;
99 
100  virtual const int* borrowListOfTagsInUse(int functionSpaceCode) const;
101 
102  virtual escript::Data randomFill(const DataTypes::ShapeType& shape,
103  const FunctionSpace& what, long seed,
104  const boost::python::tuple& filter) const;
105 
106  void addUsedTag(int t);
107  void clearUsedTags();
108  void assignTags(std::vector<int> t);
109  void resetTagAssignments();
110 
111 private:
112  DataTypes::dim_t m_totalsamples; // samples in all worlds
113  DataTypes::dim_t m_samples; // number of samples
114  DataTypes::dim_t m_originsample;
115  DataTypes::dim_t m_endsample;
116 
117 
118  int m_dpps; // data points per sample
119  int m_dpsize; // how big are the datapoints?
120  DataTypes::dim_t* m_samplerefids; // sample reference ids
121 
122  std::vector<int> mytags;
123  std::vector<int> tag_assignment; // which tag is assigned to each sample
124  // to make testing easier, the tags in use list is
125  // controlled separately
126  escript::JMPI myworld;
127 };
128 
130 FunctionSpace getTestDomainFunctionSpace(int dpps, DataTypes::dim_t samples, int dpsize);
131 
132 } // end of namespace
133 
134 #endif // __ESCRIPT_TESTDOMAIN_H__
135 
ESCRIPT_DLL_API
#define ESCRIPT_DLL_API
Definition: escriptcore/src/system_dep.h:29
escript::MPIBarrierWorld
void MPIBarrierWorld()
performs a barrier synchronization across all processors.
Definition: Utils.cpp:377
escript::TestDomain::~TestDomain
virtual ~TestDomain()
Definition: TestDomain.cpp:79
escript::TestDomain::getSolutionCode
virtual int getSolutionCode() const
Definition: TestDomain.cpp:202
escript::TestDomain::getContinuousFunctionCode
virtual int getContinuousFunctionCode() const
Definition: TestDomain.cpp:177
escript::DomainException
Definition: DomainException.h:39
escript::TestDomain::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: TestDomain.cpp:151
escript::TestDomain::isValidFunctionSpaceType
virtual bool isValidFunctionSpaceType(int functionSpaceType) const
Returns true if the given integer is a valid function space type for this domain.
Definition: TestDomain.cpp:118
escript::TestDomain::getTagFromSampleNo
virtual int getTagFromSampleNo(int functionSpaceType, DataTypes::index_t sampleNo) const
Return the tag key for the given sample number.
Definition: TestDomain.cpp:222
escript::DataTypes::DataVectorAlt< real_t >
escript::randomFillArray
void randomFillArray(long seed, double *array, size_t n)
Definition: Random.cpp:74
escript::TestDomain::getFunctionOnContactZeroCode
virtual int getFunctionOnContactZeroCode() const
Definition: TestDomain.cpp:192
escript::TestDomain
(Testing use only) Provides a domain to wrap a collection of values.
Definition: TestDomain.h:54
escript::TestDomain::assignTags
void assignTags(std::vector< int > t)
Definition: TestDomain.cpp:327
escript::Domain_ptr
boost::shared_ptr< AbstractDomain > Domain_ptr
Definition: AbstractDomain.h:53
escript::TestDomain::borrowSampleReferenceIDs
virtual const DataTypes::dim_t * borrowSampleReferenceIDs(int functionSpaceType) const
Returns a borrowed pointer to the sample reference number id list.
Definition: TestDomain.cpp:233
escript::getMPISizeWorld
int getMPISizeWorld()
returns the total number of available MPI processes for MPI_COMM_WORLD
Definition: Utils.cpp:94
escript::TestDomain::getMPIRank
virtual int getMPIRank() const
return the number MPI rank of this processor
Definition: TestDomain.cpp:89
escript::TestDomain::operator!=
virtual bool operator!=(const AbstractDomain &other) const
Return true if given domains are not equal.
Definition: TestDomain.cpp:249
escript::FunctionSpace
Definition: FunctionSpace.h:47
escript::makeInfo
JMPI makeInfo(MPI_Comm comm, bool owncom)
Definition: EsysMPI.cpp:41
escript::Data::getFunctionSpace
const FunctionSpace & getFunctionSpace() const
Return the function space.
Definition: Data.h:462
speckley::probeInterpolationAcross
bool probeInterpolationAcross(int fsType_source, const escript::AbstractDomain &domain, int fsType_target, int dim)
Definition: CrossDomainCoupler.cpp:31
escript::FunctionSpace::getDomain
const_Domain_ptr getDomain() const
Returns the function space domain.
Definition: FunctionSpace.cpp:102
escript::TestDomain::getMPI
virtual escript::JMPI getMPI() const
returns a shared pointer to the MPI information wrapper for this domain
Definition: TestDomain.cpp:111
system_dep.h
escript::TestDomain::TestDomain
TestDomain(int pointspersample, int numsamples, int dpsize=1)
Definition: TestDomain.cpp:50
MPI_COMM_WORLD
#define MPI_COMM_WORLD
Definition: EsysMPI.h:47
Utils.h
escript::Data
Data represents a collection of datapoints.
Definition: Data.h:63
escript::DataException
Definition: DataException.h:39
escript::TestDomain::getFunctionOnBoundaryCode
virtual int getFunctionOnBoundaryCode() const
Definition: TestDomain.cpp:187
escript::TestDomain::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: TestDomain.cpp:292
escript::DataTypes::dim_t
index_t dim_t
Definition: DataTypes.h:90
escript::DataTypes::ShapeType
std::vector< int > ShapeType
The shape of a single datapoint.
Definition: DataTypes.h:68
escript::JMPI
boost::shared_ptr< JMPI_ > JMPI
Definition: EsysMPI.h:71
DomainException.h
escript::TestDomain::borrowListOfTagsInUse
virtual const int * borrowListOfTagsInUse(int functionSpaceCode) const
Definition: TestDomain.cpp:322
escript::TestDomain::getX
virtual escript::Data getX() const
Returns locations in the domain. The function space is chosen appropriately.
Definition: TestDomain.cpp:264
escript::TestDomain::resetTagAssignments
void resetTagAssignments()
Definition: TestDomain.cpp:341
escript::TestDomain::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: TestDomain.cpp:217
escript::TestDomain::getDefaultCode
virtual int getDefaultCode() const
Definition: TestDomain.cpp:172
escript::TestDomain::addUsedTag
void addUsedTag(int t)
Definition: TestDomain.cpp:304
escript::TestDomain::getMPISize
virtual int getMPISize() const
return the number of processors used for this domain
Definition: TestDomain.cpp:84
escript::TestDomain::operator==
virtual bool operator==(const AbstractDomain &other) const
Return true if given domains are equal.
Definition: TestDomain.cpp:243
escript::TestDomain::getReducedSolutionCode
virtual int getReducedSolutionCode() const
Definition: TestDomain.cpp:207
escript::TestDomain::functionSpaceTypeAsString
virtual std::string functionSpaceTypeAsString(int functionSpaceType) const
Return a description for the given function space type code.
Definition: TestDomain.cpp:128
escript::TestDomain::canTag
virtual bool canTag(int functionSpaceCode) const
Checks if this domain allows tags for the specified functionSpaceCode.
Definition: TestDomain.cpp:254
escript::TestDomain::commonFunctionSpace
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: TestDomain.cpp:162
escript::TestDomain::MPIBarrier
virtual void MPIBarrier() const
If compiled for MPI then execute an MPI_Barrier, else do nothing.
Definition: TestDomain.cpp:94
escript::TestDomain::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: TestDomain.cpp:133
escript::TestDomain::clearUsedTags
void clearUsedTags()
Definition: TestDomain.cpp:316
escript::getTestDomainFunctionSpace
FunctionSpace getTestDomainFunctionSpace(int dpps, DataTypes::dim_t samples, int dpsize)
Definition: TestDomain.cpp:351
escript::TestDomain::getNumberOfTagsInUse
virtual int getNumberOfTagsInUse(int functionSpaceCode) const
returns the number of tags in use and a pointer to an array with the number of tags in use
Definition: TestDomain.cpp:259
escript::TestDomain::getDiracDeltaFunctionsCode
virtual int getDiracDeltaFunctionsCode() const
Definition: TestDomain.cpp:212
escript::DataTypes::index_t
int index_t
type for array/matrix indices used both globally and on each rank
Definition: DataTypes.h:85
Random.h
escript
Definition: AbstractContinuousDomain.cpp:23
escript::DataTypes::DataVectorAlt::size
size_type size() const
Return the number of elements in this DataVectorAlt.
Definition: DataVectorAlt.h:240
escript::TestDomain::probeInterpolationOnDomain
virtual bool probeInterpolationOnDomain(int functionSpaceType_source, int functionSpaceType_target) const
True if interpolation is possible from source to target.
Definition: TestDomain.cpp:142
NullDomain.h
escript::TestDomain::getFunctionOnContactOneCode
virtual int getFunctionOnContactOneCode() const
Definition: TestDomain.cpp:197
escript::TestDomain::probeInterpolationAcross
virtual bool probeInterpolationAcross(int functionSpaceType_source, const AbstractDomain &targetDomain, int functionSpaceType_target) const
Definition: TestDomain.cpp:156
escript::TestDomain::getDescription
virtual std::string getDescription() const
Return a description for this domain.
Definition: TestDomain.cpp:123
Data.h
escript::AbstractDomain
Base class for all escript domains.
Definition: AbstractDomain.h:62
escript::getMPIRankWorld
int getMPIRankWorld()
returns the MPI processor number within MPI_COMM_WORLD
Definition: Utils.cpp:103
escript::TestDomain::onMasterProcessor
virtual bool onMasterProcessor() const
Return true if on MPI master, else false.
Definition: TestDomain.cpp:99
escript::TestDomain::getFunctionCode
virtual int getFunctionCode() const
Definition: TestDomain.cpp:182
escript::TestDomain::getDim
virtual int getDim() const
Returns the spatial dimension of the domain.
Definition: TestDomain.cpp:238
TestDomain.h
escript::DataTypes::scalarShape
static const ShapeType scalarShape
Use this instead of creating empty shape objects for scalars.
Definition: DataTypes.h:72