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

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

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

trunk/esys2/escript/src/Data/NullDomain.h revision 110 by jgs, Mon Feb 14 04:14:42 2005 UTC temp/escript/src/NullDomain.h revision 1387 by trankine, Fri Jan 11 07:45:26 2008 UTC
# Line 1  Line 1 
1  /*  
2   ******************************************************************************  /* $Id$ */
3   *                                                                            *  
4   *       COPYRIGHT  ACcESS 2004 -  All Rights Reserved                        *  /*******************************************************
5   *                                                                            *   *
6   * This software is the property of ACcESS. No part of this code              *   *           Copyright 2003-2007 by ACceSS MNRF
7   * may be copied in any form or by any means without the expressed written    *   *       Copyright 2007 by University of Queensland
8   * consent of ACcESS.  Copying, use or modification of this software          *   *
9   * by any unauthorised person is illegal unless that person has a software    *   *                http://esscc.uq.edu.au
10   * license agreement with ACcESS.                                             *   *        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  #if !defined  escript_NullDomain_20040604_H  
16    #if !defined escript_NullDomain_20040604_H
17  #define escript_NullDomain_20040604_H  #define escript_NullDomain_20040604_H
18    #include "system_dep.h"
19    
20  #include "escript/Data/AbstractDomain.h"  #include "AbstractDomain.h"
21    
22  #include <string>  #include <string>
23    
# Line 28  namespace escript { Line 30  namespace escript {
30    
31     Description:     Description:
32     NullDomain provides a null value for domain. Needed for the construction     NullDomain provides a null value for domain. Needed for the construction
33     of a default FunctionSpace.     of a default FunctionSpace. Inherits from AbstractDomain and overrides its
34       methods.
35  */  */
36    
37  class NullDomain : public AbstractDomain {  class NullDomain : public AbstractDomain {
38    
39   public:   public:
40    
41    /**    /**
42       \brief       \brief
43       Default constructor for NullDomain       Default constructor for NullDomain.
44    
45       Description:       Description:
46       Default constructor for NullDomain       Default constructor for NullDomain.
47    
48    */    */
49      ESCRIPT_DLL_API
50    NullDomain();    NullDomain();
51    
52    /**    /**
53       \brief       \brief
54       Returns true if the given integer is a valid function space type       Returns true if the given integer is a valid function space type
55       for this domain.       for this domain.
56    */    */
57      ESCRIPT_DLL_API
58    virtual bool isValidFunctionSpaceType(int functionSpaceType) const;    virtual bool isValidFunctionSpaceType(int functionSpaceType) const;
59    
60    /**    /**
61       \brief       \brief
62       Return a description for this domain       Return a description for this domain.
63    */    */
64      ESCRIPT_DLL_API
65    virtual std::string getDescription() const;    virtual std::string getDescription() const;
66    
67    /**    /**
68       \brief       \brief
69       Return a continuous FunctionSpace       Return a continuous FunctionSpace.
70    */    */
71      ESCRIPT_DLL_API
72    virtual int getContinuousFunctionCode() const;    virtual int getContinuousFunctionCode() const;
73    
74    /**    /**
75       \brief       \brief
76       Return a functon FunctionSpace       Return a function FunctionSpace.
77    */    */
78      ESCRIPT_DLL_API
79    virtual int getFunctionCode() const;    virtual int getFunctionCode() const;
80    
81    /**    /**
82       \brief       \brief
83       Return a function on boundary FunctionSpace       Return a function on boundary FunctionSpace.
84    */    */
85      ESCRIPT_DLL_API
86    virtual int getFunctionOnBoundaryCode() const;    virtual int getFunctionOnBoundaryCode() const;
87    
88    /**    /**
89       \brief       \brief
90       Return a FunctionSpace       Return a FunctionSpace.
91    */    */
92      ESCRIPT_DLL_API
93    virtual int getFunctionOnContactZeroCode() const;    virtual int getFunctionOnContactZeroCode() const;
94    
95    /**    /**
96       \brief       \brief
97       Return a FunctionSpace       Return a FunctionSpace.
98    */    */
99      ESCRIPT_DLL_API
100    virtual int getFunctionOnContactOneCode() const;    virtual int getFunctionOnContactOneCode() const;
101    
102    /**    /**
103       \brief       \brief
104       Return a FunctionSpace       Return a FunctionSpace.
105    */    */
106      ESCRIPT_DLL_API
107    virtual int getSolutionCode() const;    virtual int getSolutionCode() const;
108    
109    /**    /**
110       \brief       \brief
111       Return a FunctionSpace       Return a FunctionSpace.
112    */    */
113      ESCRIPT_DLL_API
114    virtual int getReducedSolutionCode() const;    virtual int getReducedSolutionCode() const;
115    
116    /**    /**
117       \brief       \brief
118       Return a FunctionSpace       Return a FunctionSpace.
119    */    */
120      ESCRIPT_DLL_API
121    virtual int getDiracDeltaFunctionCode() const;    virtual int getDiracDeltaFunctionCode() const;
122   /**  
123      /**
124       \brief       \brief
125       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.
126       \param functionSpaceCode Input - Code for the function space type.       \param functionSpaceCode Input - Code for the function space type.
127       \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
128    */    */
129      ESCRIPT_DLL_API
130    virtual std::pair<int,int> getDataShape(int functionSpaceCode) const;    virtual std::pair<int,int> getDataShape(int functionSpaceCode) const;
131    
132    /**    /**
133       \brief       \brief
134       Return the tag key for the given sample number.       Return the tag key for the given sample number.
135       \param functionSpaceType Input - The function space type.       \param functionSpaceType Input - The function space type.
136       \param sampleNo Input - The sample number.       \param sampleNo Input - The sample number.
137    */    */
138      ESCRIPT_DLL_API
139    virtual int getTagFromSampleNo(int functionSpaceType, int sampleNo) const;    virtual int getTagFromSampleNo(int functionSpaceType, int sampleNo) const;
140    
141    /**    /**
142       \brief       \brief
143       Return the reference number of  the given sample number.       Return a borrowed pointer to the sample reference number id list
144       \param functionSpaceType Input - The function space type.       \param functionSpaceType Input - The function space type.
      \param sampleNo Input - The sample number.  
145    */    */
146    virtual int getReferenceNoFromSampleNo(int functionSpaceType, int sampleNo) const;    ESCRIPT_DLL_API
147      virtual int* borrowSampleReferenceIDs(int functionSpaceType) const;
148    
149    /**    /**
150       \brief       \brief
151    */    */
152      ESCRIPT_DLL_API
153    virtual int getDim() const;    virtual int getDim() const;
154    
155      /**
156         \brief
157         Return true if given domains are equal.
158      */
159      ESCRIPT_DLL_API
160      virtual bool operator==(const AbstractDomain& other) const;
161      ESCRIPT_DLL_API
162      virtual bool operator!=(const AbstractDomain& other) const;
163    
164   protected:   protected:
165    
166   private:   private:
167    
168  };  };
169    
170  } // end of namespace  } // end of namespace
171    
172  #endif  #endif

Legend:
Removed from v.110  
changed lines
  Added in v.1387

  ViewVC Help
Powered by ViewVC 1.1.26