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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 155 - (hide annotations)
Wed Nov 9 02:02:19 2005 UTC (13 years, 11 months ago) by jgs
Original Path: trunk/escript/src/Data/NullDomain.h
File MIME type: text/plain
File size: 3888 byte(s)
move all directories from trunk/esys2 into trunk and remove esys2

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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.26