FreeFOAM The Cross-Platform CFD Toolkit
restrainedHarmonicSpring Class Reference

#include <potential/restrainedHarmonicSpring.H>


Detailed Description

+ Inheritance diagram for restrainedHarmonicSpring:
+ Collaboration diagram for restrainedHarmonicSpring:

List of all members.

Public Member Functions

 TypeName ("restrainedHarmonicSpring")
 Runtime type information.
 restrainedHarmonicSpring (const word &name, const dictionary &tetherPotentialProperties)
 Construct from components.
 ~restrainedHarmonicSpring ()
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

restrainedHarmonicSpring ( const word name,
const dictionary tetherPotentialProperties 
)

Construct from components.

Definition at line 51 of file restrainedHarmonicSpring.C.

Definition at line 82 of file restrainedHarmonicSpring.H.


Member Function Documentation

TypeName ( "restrainedHarmonicSpring"  )

Runtime type information.

scalar energy ( const vector  r) const
virtual

Implements tetherPotential.

Definition at line 73 of file restrainedHarmonicSpring.C.

References Foam::mag(), and Foam::magSqr().

vector force ( const vector  r) const
virtual

Implements tetherPotential.

Definition at line 89 of file restrainedHarmonicSpring.C.

References Foam::mag().

bool read ( const dictionary tetherPotentialProperties)
virtual

Read dictionary.

Implements tetherPotential.

Definition at line 105 of file restrainedHarmonicSpring.C.

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


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