/[escript]/trunk/escript/src/NullDomain.h
ViewVC logotype

Contents of /trunk/escript/src/NullDomain.h

Parent Directory Parent Directory | Revision Log Revision Log


Revision 474 - (show annotations)
Mon Jan 30 04:23:44 2006 UTC (13 years, 6 months ago) by jgs
File MIME type: text/plain
File size: 3875 byte(s)
restructure escript source tree
move src/Data/* -> src
remove inc
modify #includes and cpppath settings accordingly

1 /*
2 ******************************************************************************
3 * *
4 * COPYRIGHT ACcESS 2004 - All Rights Reserved *
5 * *
6 * This software is the property of ACcESS. No part of this code *
7 * may be copied in any form or by any means without the expressed written *
8 * consent of ACcESS. Copying, use or modification of this software *
9 * by any unauthorised person is illegal unless that person has a software *
10 * license agreement with ACcESS. *
11 * *
12 ******************************************************************************
13 */
14
15 #if !defined escript_NullDomain_20040604_H
16 #define escript_NullDomain_20040604_H
17
18 #include "AbstractDomain.h"
19
20 #include <string>
21
22 namespace escript {
23
24 /**
25 \brief
26 NullDomain provides a null value for domain. Needed for the construction
27 of a default FunctionSpace.
28
29 Description:
30 NullDomain provides a null value for domain. Needed for the construction
31 of a default FunctionSpace. Inherits from AbstractDomain and overrides its
32 methods.
33 */
34
35 class NullDomain : public AbstractDomain {
36
37 public:
38
39 /**
40 \brief
41 Default constructor for NullDomain.
42
43 Description:
44 Default constructor for NullDomain.
45
46 */
47 NullDomain();
48
49 /**
50 \brief
51 Returns true if the given integer is a valid function space type
52 for this domain.
53 */
54 virtual bool isValidFunctionSpaceType(int functionSpaceType) const;
55
56 /**
57 \brief
58 Return a description for this domain.
59 */
60 virtual std::string getDescription() const;
61
62 /**
63 \brief
64 Return a continuous FunctionSpace.
65 */
66 virtual int getContinuousFunctionCode() const;
67
68 /**
69 \brief
70 Return a function FunctionSpace.
71 */
72 virtual int getFunctionCode() const;
73
74 /**
75 \brief
76 Return a function on boundary FunctionSpace.
77 */
78 virtual int getFunctionOnBoundaryCode() const;
79
80 /**
81 \brief
82 Return a FunctionSpace.
83 */
84 virtual int getFunctionOnContactZeroCode() const;
85
86 /**
87 \brief
88 Return a FunctionSpace.
89 */
90 virtual int getFunctionOnContactOneCode() const;
91
92 /**
93 \brief
94 Return a FunctionSpace.
95 */
96 virtual int getSolutionCode() const;
97
98 /**
99 \brief
100 Return a FunctionSpace.
101 */
102 virtual int getReducedSolutionCode() const;
103
104 /**
105 \brief
106 Return a FunctionSpace.
107 */
108 virtual int getDiracDeltaFunctionCode() const;
109
110 /**
111 \brief
112 Return the number of data points per sample, and the number of samples as a pair.
113 \param functionSpaceCode Input - Code for the function space type.
114 \return pair, first - number of data points per sample, second - number of samples
115 */
116 virtual std::pair<int,int> getDataShape(int functionSpaceCode) const;
117
118 /**
119 \brief
120 Return the tag key for the given sample number.
121 \param functionSpaceType Input - The function space type.
122 \param sampleNo Input - The sample number.
123 */
124 virtual int getTagFromSampleNo(int functionSpaceType, int sampleNo) const;
125
126 /**
127 \brief
128 Return the reference number of the given sample number.
129 \param functionSpaceType Input - The function space type.
130 \param sampleNo Input - The sample number.
131 */
132 virtual int getReferenceNoFromSampleNo(int functionSpaceType, int sampleNo) const;
133
134 /**
135 \brief
136 */
137 virtual int getDim() const;
138
139 /**
140 \brief
141 Return true if given domains are equal.
142 */
143 virtual bool operator==(const AbstractDomain& other) const;
144 virtual bool operator!=(const AbstractDomain& other) const;
145
146 protected:
147
148 private:
149
150 };
151
152 } // end of namespace
153
154 #endif

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.26