Package esys :: Package lsm :: Package geometry :: Module GeometryPy :: Class SimpleSphere
[hide private]
[frames] | no frames]

Class SimpleSphere

 object --+    
          |    
??.instance --+
              |
             SimpleSphere

Instance Methods [hide private]
bool
__eq__(...)
Equality operator for particles, simply compares particle ID values.
 
__getinitargs__(...)
int
__hash__(...)
Returns a hash value for use in dictionaries and sets.
 
__init__(...)
Constructs a spherical particle.
 
__reduce__(...)
helper for pickle
esys.lsm.util.Vec3
getCenter(...)
Returns the centre point of this sphere.
esys.lsm.util.Vec3
getCentre(...)
Returns the centre point of this sphere.
int
getId(...)
Returns the id associated with this particle.
float
getMass(...)
Returns the mass of this particle.
esys.lsm.util.Vec3
getPos(...)
Returns the centre point of this sphere.
esys.lsm.util.Vec3
getPosn(...)
Returns the centre point of this sphere.
float
getRad(...)
Returns the radius of this sphere.
float
getRadius(...)
Returns the radius of this sphere.
int
getTag(...)
Returns the tag assigned to this particle.
 
rotate(...)
Performs rigid body rotation of the sphere about a specified axis.
 
setCenter(...)
Sets the centre-point of this sphere.
 
setCentre(...)
Sets the centre-point of this sphere.
 
setId(...)
Sets the ID of this spherical particle.
 
setMass(...)
Sets the mass of this particle.
 
setPos(...)
Sets the centre-point of this sphere.
 
setPosn(...)
Sets the centre-point of this sphere.
 
setRad(...)
Sets the radius of this sphere.
 
setRadius(...)
Sets the radius of this sphere.
 
setTag(...)
Sets the tag associated with this particle.
 
translate(...)
Moves the centre-point of this sphere by a specified translation.

Inherited from unreachable.instance: __new__

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

Class Variables [hide private]
  __instance_size__ = 64
  __safe_for_unpickling__ = True
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__eq__(...)
(Equality operator)

 

Equality operator for particles, simply compares particle ID values.

Returns: bool
self.getId() == p.getId()

__hash__(...)
(Hashing function)

 

Returns a hash value for use in dictionaries and sets.

Returns: int
self.getId()
Overrides: object.__hash__

__init__(...)
(Constructor)

 

Constructs a spherical particle.

Parameters:
  • centre (esys.lsm.util.Vec3) - Centre point of the spherical particle.
  • radius (float) - Radius of the spherical particle.
  • id (int) - Unique identifier for the particle.
  • tag (int) - Label for the particle.
  • mass (float) - The mass of the spherical particle.
Overrides: object.__init__

__reduce__(...)

 

helper for pickle

Overrides: object.__reduce__
(inherited documentation)

getCenter(...)

 

Returns the centre point of this sphere.

Returns: esys.lsm.util.Vec3
Returns the centre point of this sphere.

getCentre(...)

 

Returns the centre point of this sphere.

Returns: esys.lsm.util.Vec3
Returns the centre point of this sphere.

getId(...)

 

Returns the id associated with this particle.

Returns: int
Particle ID.

getMass(...)

 

Returns the mass of this particle.

Returns: float
mass

getPos(...)

 

Returns the centre point of this sphere.

Returns: esys.lsm.util.Vec3
Returns the centre point of this sphere.

getPosn(...)

 

Returns the centre point of this sphere.

Returns: esys.lsm.util.Vec3
Returns the centre point of this sphere.

getRad(...)

 

Returns the radius of this sphere.

Returns: float
Radius of this sphere.

getRadius(...)

 

Returns the radius of this sphere.

Returns: float
Radius of this sphere.

getTag(...)

 

Returns the tag assigned to this particle.

Returns: int
tag value assigned to this particle.

rotate(...)

 

Performs rigid body rotation of the sphere about a specified axis.

Parameters:

setCenter(...)

 

Sets the centre-point of this sphere.

Parameters:

setCentre(...)

 

Sets the centre-point of this sphere.

Parameters:

setId(...)

 

Sets the ID of this spherical particle.

Parameters:
  • id (int) - Identifier for this particle.

setMass(...)

 

Sets the mass of this particle.

Parameters:
  • mass (float) - the new mass.

setPos(...)

 

Sets the centre-point of this sphere.

Parameters:

setPosn(...)

 

Sets the centre-point of this sphere.

Parameters:

setRad(...)

 

Sets the radius of this sphere.

Parameters:
  • radius (float) - radius.

setRadius(...)

 

Sets the radius of this sphere.

Parameters:
  • radius (float) - radius.

setTag(...)

 

Sets the tag associated with this particle.

Parameters:
  • tag (int) - Identifier for this particle.

translate(...)

 

Moves the centre-point of this sphere by a specified translation.

Parameters: