Package esys :: Package escript :: Module escriptcpp :: Class FunctionSpace
[hide private]
[frames] | no frames]

Class FunctionSpace

 object --+    
          |    
??.instance --+
              |
             FunctionSpace

A FunctionSpace describes which points from the Domain to use to represent functions.
Instance Methods [hide private]
 
__eq__(...)
__eq__( (FunctionSpace)arg1, (FunctionSpace)arg2) -> object
 
__init__(...)
__init__( (object)arg1) -> None
 
__ne__(...)
__ne__( (FunctionSpace)arg1, (FunctionSpace)arg2) -> object
 
__reduce__(...)
helper for pickle
 
__str__(...)
__str__( (FunctionSpace)arg1) -> str
int
getApproximationOrder(...)
Returns: the approximation order refering to the maximum degree of a polynomial which can be represenred exactly in interplation and/or integration.
int
getDim(...)
Returns: the spatial dimension of the underlying domain.
Domain
getDomain(...)
Returns: the underlying Domain for this FunctionSpace.
list
getListOfTags(...)
Returns: a list of the tags used in this function space
Data
getNormal(...)
Returns: the surface normal field.
int
getReferenceIDFromDataPointNo(...)
Returns: the reference number associated with dataPointNo
Data
getSize(...)
Returns: sample size
int
getTagFromDataPointNo(...)
Returns: the tag associated with the given sample number.
Data
getX(...)
getX( (FunctionSpace)arg1) -> Data :
 
setTags(...)
Set tags according to a mask

Inherited from unreachable.instance: __new__

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __subclasshook__

Class Variables [hide private]
  __instance_size__ = 40
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(...)
(Constructor)

 
__init__( (object)arg1) -> None
Overrides: object.__init__

__reduce__(...)

 
helper for pickle
Overrides: object.__reduce__
(inherited documentation)

__str__(...)
(Informal representation operator)

 
__str__( (FunctionSpace)arg1) -> str
Overrides: object.__str__

getApproximationOrder(...)

 
getApproximationOrder( (FunctionSpace)arg1) -> int :
Returns: int
the approximation order refering to the maximum degree of a polynomial which can be represenred exactly in interplation and/or integration.

getDim(...)

 
getDim( (FunctionSpace)arg1) -> int :
Returns: int
the spatial dimension of the underlying domain.

getDomain(...)

 
getDomain( (FunctionSpace)arg1) -> Domain :
Returns: Domain
the underlying Domain for this FunctionSpace.

getListOfTags(...)

 
getListOfTags( (FunctionSpace)arg1) -> list :
Returns: list
a list of the tags used in this function space

getNormal(...)

 
getNormal( (FunctionSpace)arg1) -> Data :
Returns: Data
the surface normal field.

getReferenceIDFromDataPointNo(...)

 
getReferenceIDFromDataPointNo( (FunctionSpace)arg1, (int)dataPointNo) -> int :
Returns: int
the reference number associated with dataPointNo

getSize(...)

 
getSize( (FunctionSpace)arg1) -> Data :
Returns: Data
sample size

getTagFromDataPointNo(...)

 
getTagFromDataPointNo( (FunctionSpace)arg1, (int)arg2) -> int :
Returns: int
the tag associated with the given sample number.

getX(...)

 

getX( (FunctionSpace)arg1) -> Data :

Returns: Data
a function whose values are its input coordinates. ie an identity function.

setTags(...)

 
setTags( (FunctionSpace)arg1, (int)newtag, (Data)mask) -> None :
Set tags according to a mask

setTags( (FunctionSpace)arg1, (str)newtag, (Data)mask) -> None

Parameters:
  • newtag (string, non-zero int) - tag number to set
  • mask (scalar Data) - Samples which correspond to positive values in the mask will be set to newtag.