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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 110 - (hide annotations)
Mon Feb 14 04:14:42 2005 UTC (14 years, 8 months ago) by jgs
Original Path: trunk/esys2/escript/src/Data/NullDomain.h
File MIME type: text/plain
File size: 3682 byte(s)
*** empty log message ***

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    
15     #if !defined escript_NullDomain_20040604_H
16     #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     of a default FunctionSpace.
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     \brief
48     Returns true if the given integer is a valid function space type
49     for this domain.
50     */
51     virtual bool isValidFunctionSpaceType(int functionSpaceType) const;
52     /**
53     \brief
54     Return a description for this domain
55     */
56     virtual std::string getDescription() const;
57     /**
58     \brief
59     Return a continuous FunctionSpace
60     */
61     virtual int getContinuousFunctionCode() const;
62     /**
63     \brief
64     Return a functon FunctionSpace
65     */
66     virtual int getFunctionCode() const;
67     /**
68     \brief
69     Return a function on boundary FunctionSpace
70     */
71     virtual int getFunctionOnBoundaryCode() const;
72     /**
73     \brief
74     Return a FunctionSpace
75     */
76     virtual int getFunctionOnContactZeroCode() const;
77     /**
78     \brief
79     Return a FunctionSpace
80     */
81     virtual int getFunctionOnContactOneCode() const;
82     /**
83     \brief
84     Return a FunctionSpace
85     */
86     virtual int getSolutionCode() const;
87     /**
88     \brief
89     Return a FunctionSpace
90     */
91     virtual int getReducedSolutionCode() const;
92     /**
93     \brief
94     Return a FunctionSpace
95     */
96     virtual int getDiracDeltaFunctionCode() const;
97     /**
98     \brief
99     Return the number of data points per sample, and the number of samples as a pair.
100     \param functionSpaceCode Input - Code for the function space type.
101     \return pair, first - number of data points per sample, second - number of samples
102     */
103     virtual std::pair<int,int> getDataShape(int functionSpaceCode) const;
104     /**
105     \brief
106     Return the tag key for the given sample number.
107     \param functionSpaceType Input - The function space type.
108     \param sampleNo Input - The sample number.
109     */
110     virtual int getTagFromSampleNo(int functionSpaceType, int sampleNo) const;
111     /**
112     \brief
113 jgs 110 Return the reference number of the given sample number.
114     \param functionSpaceType Input - The function space type.
115     \param sampleNo Input - The sample number.
116 jgs 82 */
117 jgs 110 virtual int getReferenceNoFromSampleNo(int functionSpaceType, int sampleNo) const;
118     /**
119     \brief
120     */
121 jgs 82 virtual int getDim() const;
122     protected:
123    
124     private:
125     };
126    
127     } // end of namespace
128     #endif

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.26