Home       Trees       Indices       Help   
Package esys :: Package escript :: Module escriptcpp :: Class Domain
[hide private]
[frames] | no frames]

Class Domain

 object --+    
          |    
??.instance --+
              |
             Domain
Known Subclasses:
Base class for all domains.
Instance Methods [hide private]
 
MPIBarrier(...)
Wait until all processes have reached this point
 
__eq__(...)
__eq__( (Domain)arg1, (Domain)arg2) -> object
 
__init__(...)
Raises an exception This class cannot be instantiated from Python
 
__ne__(...)
__ne__( (Domain)arg1, (Domain)arg2) -> object
 
__reduce__(...)
helper for pickle
 
dump(...)
Dumps the domain to a file:param filename: :type filename: string
int
getDim(...)
Returns: Spatial dimension of the Domain
int
getMPIRank(...)
Returns: the rank of this process
int
getMPISize(...)
Returns: the number of processes used for this Domain
escript
getNormal(...)
Returns: Boundary normals
Data
getSize(...)
Returns: the local size of samples.
int
getStatus(...)
The status of a domain changes whenever the domain is modified
string
getTag(...)
Returns: tag id for name
Data
getX(...)
Returns: Locations in the`Domain`.
bool
isValidTagName(...)
Returns: True is name corresponds to a tag
bool
onMasterProcessor(...)
Returns: True if this code is executing on the master process
 
saveDX(...)
Saves a dictonary of Data objects to an OpenDX input file.
 
saveVTK(...)
 
setTagMap(...)
Give a tag number a name.
string
showTagNames(...)
Returns: A space separated list of tag names
 
supportsContactElements(...)
Does this domain support contact elements.

Inherited from unreachable.instance: __new__

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

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(...)
(Constructor)

 
Raises an exception This class cannot be instantiated from Python
Overrides: object.__init__

__reduce__(...)

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

getDim(...)

 
getDim( (Domain)arg1) -> int :
Returns: int
Spatial dimension of the Domain

getMPIRank(...)

 
getMPIRank( (Domain)arg1) -> int :
Returns: int
the rank of this process

getMPISize(...)

 
getMPISize( (Domain)arg1) -> int :
Returns: int
the number of processes used for this Domain

getNormal(...)

 
getNormal( (Domain)arg1) -> Data :
Returns: escript
Boundary normals

getSize(...)

 
getSize( (Domain)arg1) -> Data :
Returns: Data
the local size of samples. The function space is chosen appropriately

getTag(...)

 
getTag( (Domain)arg1, (str)name) -> int :
Returns: string
tag id for name

getX(...)

 
getX( (Domain)arg1) -> Data :
Returns: Data
Locations in the`Domain`. FunctionSpace is chosen appropriately

isValidTagName(...)

 
isValidTagName( (Domain)arg1, (str)name) -> bool :
Returns: bool
True is name corresponds to a tag

onMasterProcessor(...)

 
onMasterProcessor( (Domain)arg1) -> bool :
Returns: bool
True if this code is executing on the master process

saveDX(...)

 
saveDX( (Domain)arg1, (str)filename, (dict)arg) -> None :
Saves a dictonary of Data objects to an OpenDX input file.
Parameters:
  • filename (string)
  • arg (dict)

saveVTK(...)

 
saveVTK( (Domain)arg1, (str)filename, (dict)arg, (str)metadata, (str)metadata_schema) -> None :
Parameters:
  • filename (string)
  • arg (dict) - items to be added
  • metadata (string) - string representing some meta data to be added
  • metadata_schema (string) - schema type for metadata

setTagMap(...)

 
setTagMap( (Domain)arg1, (str)name, (int)tag) -> None :
Give a tag number a name.
Parameters:
  • name (string) - Name for the tag
  • tag (int) - numeric id

Note: Tag names must be unique within a domain

showTagNames(...)

 
showTagNames( (Domain)arg1) -> str :
Returns: string
A space separated list of tag names

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Sat May 26 00:38:43 2012 http://epydoc.sourceforge.net