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

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

Parent Directory Parent Directory | Revision Log Revision Log


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

1 jgs 82 /*
2 elspeth 615 ************************************************************
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 jgs 82 */
12 jgs 115
13     #if !defined escript_NullDomain_20040604_H
14 jgs 82 #define escript_NullDomain_20040604_H
15    
16 jgs 474 #include "AbstractDomain.h"
17 jgs 82
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 jgs 115 of a default FunctionSpace. Inherits from AbstractDomain and overrides its
30     methods.
31 jgs 82 */
32 jgs 115
33 jgs 82 class NullDomain : public AbstractDomain {
34    
35     public:
36    
37     /**
38     \brief
39 jgs 117 Default constructor for NullDomain.
40 jgs 82
41     Description:
42 jgs 117 Default constructor for NullDomain.
43 jgs 82
44     */
45     NullDomain();
46 jgs 115
47 jgs 82 /**
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 jgs 115
54 jgs 82 /**
55     \brief
56 jgs 117 Return a description for this domain.
57 jgs 82 */
58     virtual std::string getDescription() const;
59 jgs 115
60 jgs 82 /**
61     \brief
62 jgs 117 Return a continuous FunctionSpace.
63 jgs 82 */
64     virtual int getContinuousFunctionCode() const;
65 jgs 115
66 jgs 82 /**
67     \brief
68 jgs 117 Return a function FunctionSpace.
69 jgs 82 */
70     virtual int getFunctionCode() const;
71 jgs 115
72 jgs 82 /**
73     \brief
74 jgs 117 Return a function on boundary FunctionSpace.
75 jgs 82 */
76     virtual int getFunctionOnBoundaryCode() const;
77 jgs 115
78 jgs 82 /**
79     \brief
80 jgs 117 Return a FunctionSpace.
81 jgs 82 */
82     virtual int getFunctionOnContactZeroCode() const;
83 jgs 115
84 jgs 82 /**
85     \brief
86 jgs 117 Return a FunctionSpace.
87 jgs 82 */
88     virtual int getFunctionOnContactOneCode() const;
89 jgs 115
90 jgs 82 /**
91     \brief
92 jgs 117 Return a FunctionSpace.
93 jgs 82 */
94     virtual int getSolutionCode() const;
95 jgs 115
96 jgs 82 /**
97     \brief
98 jgs 117 Return a FunctionSpace.
99 jgs 82 */
100     virtual int getReducedSolutionCode() const;
101 jgs 115
102 jgs 82 /**
103     \brief
104 jgs 117 Return a FunctionSpace.
105 jgs 82 */
106     virtual int getDiracDeltaFunctionCode() const;
107 jgs 115
108     /**
109 jgs 82 \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 jgs 115
116 jgs 82 /**
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 jgs 115
124 jgs 82 /**
125     \brief
126 jgs 117 Return the reference number of the given sample number.
127 jgs 110 \param functionSpaceType Input - The function space type.
128     \param sampleNo Input - The sample number.
129 jgs 82 */
130 jgs 110 virtual int getReferenceNoFromSampleNo(int functionSpaceType, int sampleNo) const;
131 jgs 115
132 jgs 110 /**
133     \brief
134     */
135 jgs 82 virtual int getDim() const;
136 jgs 115
137 jgs 121 /**
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 jgs 82 protected:
145    
146     private:
147 jgs 115
148 jgs 82 };
149    
150     } // end of namespace
151 jgs 117
152 jgs 82 #endif

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.26