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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1388 - (hide annotations)
Fri Jan 11 07:45:58 2008 UTC (11 years, 9 months ago) by trankine
File MIME type: text/plain
File size: 3703 byte(s)
And get the *(&(*&(* name right
1 jgs 115
2 ksteube 1312 /* $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 jgs 115 #if !defined escript_NullDomain_20040604_H
17 jgs 82 #define escript_NullDomain_20040604_H
18 woo409 757 #include "system_dep.h"
19 jgs 82
20 jgs 474 #include "AbstractDomain.h"
21 jgs 82
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 jgs 115 of a default FunctionSpace. Inherits from AbstractDomain and overrides its
34     methods.
35 jgs 82 */
36 jgs 115
37 jgs 82 class NullDomain : public AbstractDomain {
38    
39     public:
40    
41     /**
42     \brief
43 jgs 117 Default constructor for NullDomain.
44 jgs 82
45     Description:
46 jgs 117 Default constructor for NullDomain.
47 jgs 82
48     */
49 woo409 757 ESCRIPT_DLL_API
50 jgs 82 NullDomain();
51 jgs 115
52 jgs 82 /**
53     \brief
54     Returns true if the given integer is a valid function space type
55     for this domain.
56     */
57 woo409 757 ESCRIPT_DLL_API
58 jgs 82 virtual bool isValidFunctionSpaceType(int functionSpaceType) const;
59 jgs 115
60 jgs 82 /**
61     \brief
62 jgs 117 Return a description for this domain.
63 jgs 82 */
64 woo409 757 ESCRIPT_DLL_API
65 jgs 82 virtual std::string getDescription() const;
66 jgs 115
67 jgs 82 /**
68     \brief
69 jgs 117 Return a continuous FunctionSpace.
70 jgs 82 */
71 woo409 757 ESCRIPT_DLL_API
72 jgs 82 virtual int getContinuousFunctionCode() const;
73 jgs 115
74 jgs 82 /**
75     \brief
76 jgs 117 Return a function FunctionSpace.
77 jgs 82 */
78 woo409 757 ESCRIPT_DLL_API
79 jgs 82 virtual int getFunctionCode() const;
80 jgs 115
81 jgs 82 /**
82     \brief
83 jgs 117 Return a function on boundary FunctionSpace.
84 jgs 82 */
85 woo409 757 ESCRIPT_DLL_API
86 jgs 82 virtual int getFunctionOnBoundaryCode() const;
87 jgs 115
88 jgs 82 /**
89     \brief
90 jgs 117 Return a FunctionSpace.
91 jgs 82 */
92 woo409 757 ESCRIPT_DLL_API
93 jgs 82 virtual int getFunctionOnContactZeroCode() const;
94 jgs 115
95 jgs 82 /**
96     \brief
97 jgs 117 Return a FunctionSpace.
98 jgs 82 */
99 woo409 757 ESCRIPT_DLL_API
100 jgs 82 virtual int getFunctionOnContactOneCode() const;
101 jgs 115
102 jgs 82 /**
103     \brief
104 jgs 117 Return a FunctionSpace.
105 jgs 82 */
106 woo409 757 ESCRIPT_DLL_API
107 jgs 82 virtual int getSolutionCode() const;
108 jgs 115
109 jgs 82 /**
110     \brief
111 jgs 117 Return a FunctionSpace.
112 jgs 82 */
113 woo409 757 ESCRIPT_DLL_API
114 jgs 82 virtual int getReducedSolutionCode() const;
115 jgs 115
116 jgs 82 /**
117     \brief
118 jgs 117 Return a FunctionSpace.
119 jgs 82 */
120 woo409 757 ESCRIPT_DLL_API
121 jgs 82 virtual int getDiracDeltaFunctionCode() const;
122 jgs 115
123     /**
124 jgs 82 \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 woo409 757 ESCRIPT_DLL_API
130 jgs 82 virtual std::pair<int,int> getDataShape(int functionSpaceCode) const;
131 jgs 115
132 jgs 82 /**
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 woo409 757 ESCRIPT_DLL_API
139 jgs 82 virtual int getTagFromSampleNo(int functionSpaceType, int sampleNo) const;
140 jgs 115
141 jgs 82 /**
142     \brief
143 gross 964 Return a borrowed pointer to the sample reference number id list
144 jgs 110 \param functionSpaceType Input - The function space type.
145 jgs 82 */
146 woo409 757 ESCRIPT_DLL_API
147 gross 964 virtual int* borrowSampleReferenceIDs(int functionSpaceType) const;
148 jgs 115
149 jgs 110 /**
150     \brief
151     */
152 woo409 757 ESCRIPT_DLL_API
153 jgs 82 virtual int getDim() const;
154 jgs 115
155 jgs 121 /**
156     \brief
157     Return true if given domains are equal.
158     */
159 woo409 757 ESCRIPT_DLL_API
160 jgs 121 virtual bool operator==(const AbstractDomain& other) const;
161 woo409 757 ESCRIPT_DLL_API
162 jgs 121 virtual bool operator!=(const AbstractDomain& other) const;
163    
164 jgs 82 protected:
165    
166     private:
167 jgs 115
168 jgs 82 };
169    
170     } // end of namespace
171 jgs 117
172 jgs 82 #endif

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.26