sphere Class Reference

Specialisation of rigidBody to construct a sphere given the mass and radius. More...

Inheritance diagram for sphere:
Collaboration diagram for sphere:

Public Member Functions

 TypeName ("sphere")
 Runtime type information. More...
 
 sphere (const word &name, const scalar m, const vector &c, const scalar r)
 Construct from name, mass, centre of mass and radius. More...
 
 sphere (const word &name, const dictionary &dict)
 Construct from dictionary. More...
 
virtual autoPtr< rigidBodyclone () const
 Return clone of this sphere. More...
 
virtual ~sphere ()
 Destructor. More...
 
scalar r () const
 Return the radius of the sphere. More...
 
virtual void write (Ostream &) const
 Write. More...
 
- Public Member Functions inherited from rigidBody
 TypeName ("rigidBody")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, rigidBody, dictionary,(const word &name, const dictionary &dict),(name, dict))
 
 rigidBody (const word &name, const scalar &m, const vector &c, const symmTensor &Ic)
 Construct from mass, centre of mass and moment of inertia tensor. More...
 
 rigidBody (const word &name, const rigidBodyInertia &rbi)
 Construct from with the given rigidBodyInertia. More...
 
 rigidBody (const word &name, const dictionary &dict)
 Construct from dictionary. More...
 
virtual ~rigidBody ()
 Destructor. More...
 
const wordname () const
 Return name. More...
 
virtual bool massless () const
 Return false as this body is not massless. More...
 
void merge (const subBody &)
 Merge a body into this parent body. More...
 
- Public Member Functions inherited from rigidBodyInertia
 rigidBodyInertia ()
 Null constructor, initialises to zero. More...
 
 rigidBodyInertia (const scalar m, const vector &c, const symmTensor &Ic)
 Construct from mass, centre of mass and moment of inertia tensor. More...
 
 rigidBodyInertia (const dictionary &dict)
 Construct from dictionary. More...
 
 rigidBodyInertia (const spatialTensor &st)
 Construct from the components of a spatial tensor. More...
 
 rigidBodyInertia (Istream &is)
 Construct from Istream. More...
 
scalar m () const
 Return the mass of the rigid-body. More...
 
const vectorc () const
 Return the centre of mass of the rigid-body. More...
 
const symmTensorIc () const
 Return the inertia tensor of the rigid-body about the centre of mass. More...
 
symmTensor Ioc () const
 Return the difference between the inertia tensor of the rigid-body. More...
 
symmTensor Icc (const vector &c) const
 Return the difference between the inertia tensor of the rigid-body. More...
 
symmTensor Io () const
 Return the inertia tensor of the rigid-body about the origin. More...
 
scalar kineticEnergy (const spatialVector &v)
 Return the kinetic energy of the body with the given velocity. More...
 
 operator spatialTensor () const
 Conversion to spatial tensor. More...
 
void operator+= (const rigidBodyInertia &)
 

Additional Inherited Members

- Static Public Member Functions inherited from rigidBody
static autoPtr< rigidBodyNew (const word &name, const scalar &m, const vector &c, const symmTensor &Ic)
 Select constructed from components. More...
 
static autoPtr< rigidBodyNew (const word &name, const dictionary &dict)
 Select constructed from name and dictionary. More...
 
- Static Public Member Functions inherited from rigidBodyInertia
static symmTensor Ioc (const scalar m, const vector &c)
 Return the difference between the inertia tensor of the rigid-body. More...
 

Detailed Description

Specialisation of rigidBody to construct a sphere given the mass and radius.

Source files

Definition at line 51 of file sphere.H.

Constructor & Destructor Documentation

◆ sphere() [1/2]

sphere ( const word name,
const scalar  m,
const vector c,
const scalar  r 
)
inline

Construct from name, mass, centre of mass and radius.

Definition at line 41 of file sphereI.H.

◆ sphere() [2/2]

sphere ( const word name,
const dictionary dict 
)
inline

Construct from dictionary.

Definition at line 54 of file sphereI.H.

References rigidBodyInertia::c(), dictionary::lookup(), rigidBodyInertia::m(), and rigidBodyInertia::rigidBodyInertia().

Here is the call graph for this function:

◆ ~sphere()

~sphere ( )
virtual

Destructor.

Definition at line 57 of file sphere.C.

Member Function Documentation

◆ TypeName()

TypeName ( "sphere"  )

Runtime type information.

◆ clone()

Foam::autoPtr< Foam::RBD::rigidBody > clone ( ) const
virtual

Return clone of this sphere.

Reimplemented from rigidBody.

Definition at line 49 of file sphere.C.

◆ r()

Foam::scalar r ( ) const
inline

Return the radius of the sphere.

Definition at line 70 of file sphereI.H.

◆ write()

void write ( Ostream os) const
virtual

Write.

Reimplemented from rigidBody.

Definition at line 63 of file sphere.C.

References Foam::type(), and Foam::writeEntry().

Here is the call graph for this function:

The documentation for this class was generated from the following files: