/[escript]/trunk-mpi-branch/escript/src/NullDomain.h
ViewVC logotype

Contents of /trunk-mpi-branch/escript/src/NullDomain.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1306 - (show annotations)
Tue Sep 18 05:51:09 2007 UTC (11 years, 11 months ago) by ksteube
File MIME type: text/plain
File size: 3703 byte(s)
New Copyright in each .c .h .cpp and .py file

1
2 /* $Id$ */
3
4 /*******************************************************
5 *
6 * Copyright 2003-2007 by ACceSS MNRF
7 * Copyright 2007 by University of Queensland
8 *
9 * http://esscc.uq.edu.au
10 * Primary Business: Queensland, Australia
11 * Licensed under the Open Software License version 3.0
12 * http://www.opensource.org/licenses/osl-3.0.php
13 *
14 *******************************************************/
15
16 #if !defined escript_NullDomain_20040604_H
17 #define escript_NullDomain_20040604_H
18 #include "system_dep.h"
19
20 #include "AbstractDomain.h"
21
22 #include <string>
23
24 namespace escript {
25
26 /**
27 \brief
28 NullDomain provides a null value for domain. Needed for the construction
29 of a default FunctionSpace.
30
31 Description:
32 NullDomain provides a null value for domain. Needed for the construction
33 of a default FunctionSpace. Inherits from AbstractDomain and overrides its
34 methods.
35 */
36
37 class NullDomain : public AbstractDomain {
38
39 public:
40
41 /**
42 \brief
43 Default constructor for NullDomain.
44
45 Description:
46 Default constructor for NullDomain.
47
48 */
49 ESCRIPT_DLL_API
50 NullDomain();
51
52 /**
53 \brief
54 Returns true if the given integer is a valid function space type
55 for this domain.
56 */
57 ESCRIPT_DLL_API
58 virtual bool isValidFunctionSpaceType(int functionSpaceType) const;
59
60 /**
61 \brief
62 Return a description for this domain.
63 */
64 ESCRIPT_DLL_API
65 virtual std::string getDescription() const;
66
67 /**
68 \brief
69 Return a continuous FunctionSpace.
70 */
71 ESCRIPT_DLL_API
72 virtual int getContinuousFunctionCode() const;
73
74 /**
75 \brief
76 Return a function FunctionSpace.
77 */
78 ESCRIPT_DLL_API
79 virtual int getFunctionCode() const;
80
81 /**
82 \brief
83 Return a function on boundary FunctionSpace.
84 */
85 ESCRIPT_DLL_API
86 virtual int getFunctionOnBoundaryCode() const;
87
88 /**
89 \brief
90 Return a FunctionSpace.
91 */
92 ESCRIPT_DLL_API
93 virtual int getFunctionOnContactZeroCode() const;
94
95 /**
96 \brief
97 Return a FunctionSpace.
98 */
99 ESCRIPT_DLL_API
100 virtual int getFunctionOnContactOneCode() const;
101
102 /**
103 \brief
104 Return a FunctionSpace.
105 */
106 ESCRIPT_DLL_API
107 virtual int getSolutionCode() const;
108
109 /**
110 \brief
111 Return a FunctionSpace.
112 */
113 ESCRIPT_DLL_API
114 virtual int getReducedSolutionCode() const;
115
116 /**
117 \brief
118 Return a FunctionSpace.
119 */
120 ESCRIPT_DLL_API
121 virtual int getDiracDeltaFunctionCode() const;
122
123 /**
124 \brief
125 Return the number of data points per sample, and the number of samples as a pair.
126 \param functionSpaceCode Input - Code for the function space type.
127 \return pair, first - number of data points per sample, second - number of samples
128 */
129 ESCRIPT_DLL_API
130 virtual std::pair<int,int> getDataShape(int functionSpaceCode) const;
131
132 /**
133 \brief
134 Return the tag key for the given sample number.
135 \param functionSpaceType Input - The function space type.
136 \param sampleNo Input - The sample number.
137 */
138 ESCRIPT_DLL_API
139 virtual int getTagFromSampleNo(int functionSpaceType, int sampleNo) const;
140
141 /**
142 \brief
143 Return a borrowed pointer to the sample reference number id list
144 \param functionSpaceType Input - The function space type.
145 */
146 ESCRIPT_DLL_API
147 virtual int* borrowSampleReferenceIDs(int functionSpaceType) const;
148
149 /**
150 \brief
151 */
152 ESCRIPT_DLL_API
153 virtual int getDim() const;
154
155 /**
156 \brief
157 Return true if given domains are equal.
158 */
159 ESCRIPT_DLL_API
160 virtual bool operator==(const AbstractDomain& other) const;
161 ESCRIPT_DLL_API
162 virtual bool operator!=(const AbstractDomain& other) const;
163
164 protected:
165
166 private:
167
168 };
169
170 } // end of namespace
171
172 #endif

Properties

Name Value
svn:eol-style native
svn:keywords Author Date Id Revision

  ViewVC Help
Powered by ViewVC 1.1.26