FreeFOAM The Cross-Platform CFD Toolkit
harmonicSpring Class Reference

#include <potential/harmonicSpring.H>


Detailed Description

+ Inheritance diagram for harmonicSpring:
+ Collaboration diagram for harmonicSpring:

List of all members.

Public Member Functions

 TypeName ("harmonicSpring")
 Runtime type information.
 harmonicSpring (const word &name, const dictionary &tetherPotentialProperties)
 Construct from components.
 ~harmonicSpring ()
scalar energy (const vector r) const
vector force (const vector r) const
bool read (const dictionary &tetherPotentialProperties)
 Read dictionary.
- Public Member Functions inherited from tetherPotential
 TypeName ("tetherPotential")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, tetherPotential, dictionary,(const word &name, const dictionary &tetherPotentialProperties),(name, tetherPotentialProperties))
 tetherPotential (const word &name, const dictionary &tetherPotentialProperties)
 Construct from components.
virtual ~tetherPotential ()
const dictionarytetherPotentialProperties () const

Additional Inherited Members

- Static Public Member Functions inherited from tetherPotential
static autoPtr< tetherPotentialNew (const word &name, const dictionary &tetherPotentialProperties)
 Return a reference to the selected viscosity model.
- Protected Member Functions inherited from tetherPotential
 tetherPotential (const tetherPotential &)
 Disallow copy construct.
void operator= (const tetherPotential &)
 Disallow default bitwise assignment.
- Protected Attributes inherited from tetherPotential
word name_
dictionary tetherPotentialProperties_

Constructor & Destructor Documentation

harmonicSpring ( const word name,
const dictionary tetherPotentialProperties 
)

Construct from components.

Definition at line 51 of file harmonicSpring.C.

~harmonicSpring ( )
inline

Definition at line 80 of file harmonicSpring.H.


Member Function Documentation

TypeName ( "harmonicSpring"  )

Runtime type information.

scalar energy ( const vector  r) const
virtual

Implements tetherPotential.

Definition at line 67 of file harmonicSpring.C.

References Foam::magSqr().

vector force ( const vector  r) const
virtual

Implements tetherPotential.

Definition at line 73 of file harmonicSpring.C.

bool read ( const dictionary tetherPotentialProperties)
virtual

Read dictionary.

Implements tetherPotential.

Definition at line 79 of file harmonicSpring.C.

References dictionary::lookup(), and dictionary::subDict().


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