FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

restrainedHarmonicSpring Class Reference

#include <potential/restrainedHarmonicSpring.H>


Detailed Description

Source files

Definition at line 51 of file restrainedHarmonicSpring.H.

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.

Constructor & Destructor Documentation

restrainedHarmonicSpring ( const word &   name,
const dictionary &   tetherPotentialProperties  
)

Construct from components.

Definition at line 51 of file restrainedHarmonicSpring.C.

~restrainedHarmonicSpring (  ) [inline]

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: