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

Diff of /trunk/escript/src/Data/NullDomain.h

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 82 by jgs, Tue Oct 26 06:53:54 2004 UTC revision 117 by jgs, Fri Apr 1 05:48:57 2005 UTC
# Line 11  Line 11 
11   *                                                                            *   *                                                                            *
12   ******************************************************************************   ******************************************************************************
13  */  */
14                                                                              
15  #if !defined  escript_NullDomain_20040604_H  #if !defined escript_NullDomain_20040604_H
16  #define escript_NullDomain_20040604_H  #define escript_NullDomain_20040604_H
17    
18  #include "escript/Data/AbstractDomain.h"  #include "escript/Data/AbstractDomain.h"
# Line 28  namespace escript { Line 28  namespace escript {
28    
29     Description:     Description:
30     NullDomain provides a null value for domain. Needed for the construction     NullDomain provides a null value for domain. Needed for the construction
31     of a default FunctionSpace.     of a default FunctionSpace. Inherits from AbstractDomain and overrides its
32       methods.
33  */  */
34    
35  class NullDomain : public AbstractDomain {  class NullDomain : public AbstractDomain {
36    
37   public:   public:
38    
39    /**    /**
40       \brief       \brief
41       Default constructor for NullDomain       Default constructor for NullDomain.
42    
43       Description:       Description:
44       Default constructor for NullDomain       Default constructor for NullDomain.
45    
46    */    */
47    NullDomain();    NullDomain();
48    
49    /**    /**
50       \brief       \brief
51       Returns true if the given integer is a valid function space type       Returns true if the given integer is a valid function space type
52       for this domain.       for this domain.
53    */    */
54    virtual bool isValidFunctionSpaceType(int functionSpaceType) const;    virtual bool isValidFunctionSpaceType(int functionSpaceType) const;
55    
56    /**    /**
57       \brief       \brief
58       Return a description for this domain       Return a description for this domain.
59    */    */
60    virtual std::string getDescription() const;    virtual std::string getDescription() const;
61    
62    /**    /**
63       \brief       \brief
64       Return a continuous FunctionSpace       Return a continuous FunctionSpace.
65    */    */
66    virtual int getContinuousFunctionCode() const;    virtual int getContinuousFunctionCode() const;
67    
68    /**    /**
69       \brief       \brief
70       Return a functon FunctionSpace       Return a function FunctionSpace.
71    */    */
72    virtual int getFunctionCode() const;    virtual int getFunctionCode() const;
73    
74    /**    /**
75       \brief       \brief
76       Return a function on boundary FunctionSpace       Return a function on boundary FunctionSpace.
77    */    */
78    virtual int getFunctionOnBoundaryCode() const;    virtual int getFunctionOnBoundaryCode() const;
79    
80    /**    /**
81       \brief       \brief
82       Return a FunctionSpace       Return a FunctionSpace.
83    */    */
84    virtual int getFunctionOnContactZeroCode() const;    virtual int getFunctionOnContactZeroCode() const;
85    
86    /**    /**
87       \brief       \brief
88       Return a FunctionSpace       Return a FunctionSpace.
89    */    */
90    virtual int getFunctionOnContactOneCode() const;    virtual int getFunctionOnContactOneCode() const;
91    
92    /**    /**
93       \brief       \brief
94       Return a FunctionSpace       Return a FunctionSpace.
95    */    */
96    virtual int getSolutionCode() const;    virtual int getSolutionCode() const;
97    
98    /**    /**
99       \brief       \brief
100       Return a FunctionSpace       Return a FunctionSpace.
101    */    */
102    virtual int getReducedSolutionCode() const;    virtual int getReducedSolutionCode() const;
103    
104    /**    /**
105       \brief       \brief
106       Return a FunctionSpace       Return a FunctionSpace.
107    */    */
108    virtual int getDiracDeltaFunctionCode() const;    virtual int getDiracDeltaFunctionCode() const;
109   /**  
110      /**
111       \brief       \brief
112       Return the number of data points per sample, and the number of samples as a pair.       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.       \param functionSpaceCode Input - Code for the function space type.
114       \return pair, first - number of data points per sample, second - number of samples       \return pair, first - number of data points per sample, second - number of samples
115    */    */
116    virtual std::pair<int,int> getDataShape(int functionSpaceCode) const;    virtual std::pair<int,int> getDataShape(int functionSpaceCode) const;
117    
118    /**    /**
119       \brief       \brief
120       Return the tag key for the given sample number.       Return the tag key for the given sample number.
# Line 108  class NullDomain : public AbstractDomain Line 122  class NullDomain : public AbstractDomain
122       \param sampleNo Input - The sample number.       \param sampleNo Input - The sample number.
123    */    */
124    virtual int getTagFromSampleNo(int functionSpaceType, int sampleNo) const;    virtual int getTagFromSampleNo(int functionSpaceType, int sampleNo) const;
125    
126      /**
127         \brief
128         Return the reference number of the given sample number.
129         \param functionSpaceType Input - The function space type.
130         \param sampleNo Input - The sample number.
131      */
132      virtual int getReferenceNoFromSampleNo(int functionSpaceType, int sampleNo) const;
133    
134    /**    /**
135       \brief       \brief
136    */    */
137    virtual int getDim() const;    virtual int getDim() const;
138    
139   protected:   protected:
140    
141   private:   private:
142    
143  };  };
144    
145  } // end of namespace  } // end of namespace
146    
147  #endif  #endif

Legend:
Removed from v.82  
changed lines
  Added in v.117

  ViewVC Help
Powered by ViewVC 1.1.26