Public Member Functions | List of all members
restrainedHarmonicSpring Class Reference
Inheritance diagram for restrainedHarmonicSpring:
Inheritance graph
[legend]
Collaboration diagram for restrainedHarmonicSpring:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("restrainedHarmonicSpring")
 Runtime type information. More...
 
 restrainedHarmonicSpring (const word &name, const dictionary &tetherPotentialProperties)
 Construct from components. More...
 
 ~restrainedHarmonicSpring ()
 Destructor. More...
 
scalar energy (const vector r) const
 
vector force (const vector r) const
 
bool read (const dictionary &tetherPotentialProperties)
 Read dictionary. More...
 
- Public Member Functions inherited from tetherPotential
 TypeName ("tetherPotential")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, tetherPotential, dictionary,(const word &name, const dictionary &tetherPotentialProperties),(name, tetherPotentialProperties))
 
 tetherPotential (const word &name, const dictionary &tetherPotentialProperties)
 Construct from components. More...
 
 tetherPotential (const tetherPotential &)
 Disallow default bitwise copy construction. More...
 
virtual ~tetherPotential ()
 Destructor. More...
 
const dictionary & tetherPotentialProperties () const
 
void operator= (const tetherPotential &)=delete
 Disallow default bitwise assignment. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from tetherPotential
static autoPtr< tetherPotential > New (const word &name, const dictionary &tetherPotentialProperties)
 Return a reference to the selected viscosity model. More...
 
- Protected Attributes inherited from tetherPotential
word name_
 
dictionary tetherPotentialProperties_
 

Detailed Description

Source files

Definition at line 50 of file restrainedHarmonicSpring.H.

Constructor & Destructor Documentation

◆ restrainedHarmonicSpring()

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

Construct from components.

Definition at line 51 of file restrainedHarmonicSpring.C.

◆ ~restrainedHarmonicSpring()

~restrainedHarmonicSpring ( )
inline

Destructor.

Definition at line 80 of file restrainedHarmonicSpring.H.

References restrainedHarmonicSpring::energy(), restrainedHarmonicSpring::force(), and restrainedHarmonicSpring::read().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "restrainedHarmonicSpring"  )

Runtime type information.

◆ energy()

scalar energy ( const vector  r) const
virtual

Implements tetherPotential.

Definition at line 80 of file restrainedHarmonicSpring.C.

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

Referenced by restrainedHarmonicSpring::~restrainedHarmonicSpring().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ force()

vector force ( const vector  r) const
virtual

Implements tetherPotential.

Definition at line 96 of file restrainedHarmonicSpring.C.

References Foam::mag(), and restrainedHarmonicSpring::read().

Referenced by restrainedHarmonicSpring::~restrainedHarmonicSpring().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ read()

bool read ( const dictionary &  tetherPotentialProperties)
virtual

Read dictionary.

Implements tetherPotential.

Definition at line 112 of file restrainedHarmonicSpring.C.

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

Referenced by restrainedHarmonicSpring::force(), and restrainedHarmonicSpring::~restrainedHarmonicSpring().

Here is the call graph for this function:
Here is the caller graph for this function:
The documentation for this class was generated from the following files: