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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 615 - (show annotations)
Wed Mar 22 02:12:00 2006 UTC (13 years, 6 months ago) by elspeth
File MIME type: text/plain
File size: 3553 byte(s)
More copyright information.

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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.26