Loading...
Searching...
No Matches
tetherPotential Class Referenceabstract

#include <tetherPotential.H>

Inheritance diagram for tetherPotential:
Inheritance graph
[legend]
Collaboration diagram for tetherPotential:
Collaboration graph
[legend]

Public Member Functions

 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 ()=default
 Destructor.
virtual scalar energy (const vector r) const =0
virtual vector force (const vector r) const =0
const dictionary & tetherPotentialProperties () const
virtual bool read (const dictionary &tetherPotentialProperties)=0
 Read tetherPotential dictionary.

Static Public Member Functions

static autoPtr< tetherPotential > New (const word &name, const dictionary &tetherPotentialProperties)
 Return a reference to the selected viscosity model.

Protected Member Functions

 tetherPotential (const tetherPotential &)=delete
 No copy construct.
void operator= (const tetherPotential &)=delete
 No copy assignment.

Protected Attributes

word name_
dictionary tetherPotentialProperties_

Detailed Description

Source files

Definition at line 51 of file tetherPotential.H.

Constructor & Destructor Documentation

◆ tetherPotential() [1/2]

tetherPotential ( const tetherPotential & )
protecteddelete

No copy construct.

References tetherPotential().

Referenced by declareRunTimeSelectionTable(), harmonicSpring::harmonicSpring(), operator=(), pitchForkRing::pitchForkRing(), restrainedHarmonicSpring::restrainedHarmonicSpring(), and tetherPotential().

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

◆ tetherPotential() [2/2]

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

Construct from components.

Definition at line 34 of file tetherPotential.C.

References Foam::name(), name_, tetherPotentialProperties(), and tetherPotentialProperties_.

Here is the call graph for this function:

◆ ~tetherPotential()

virtual ~tetherPotential ( )
virtualdefault

Destructor.

Member Function Documentation

◆ operator=()

void operator= ( const tetherPotential & )
protecteddelete

No copy assignment.

References tetherPotential().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "tetherPotential" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr ,
tetherPotential ,
dictionary ,
(const word &name, const dictionary &tetherPotentialProperties) ,
(name, tetherPotentialProperties)  )

References Foam::name(), tetherPotential(), and tetherPotentialProperties().

Here is the call graph for this function:

◆ New()

Foam::autoPtr< Foam::tetherPotential > New ( const word & name,
const dictionary & tetherPotentialProperties )
static

Return a reference to the selected viscosity model.

Definition at line 26 of file tetherPotentialNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, Foam::Info, Foam::name(), and Foam::nl.

Here is the call graph for this function:

◆ energy()

virtual scalar energy ( const vector r) const
pure virtual

Implemented in harmonicSpring, pitchForkRing, and restrainedHarmonicSpring.

◆ force()

virtual vector force ( const vector r) const
pure virtual

Implemented in harmonicSpring, pitchForkRing, and restrainedHarmonicSpring.

◆ tetherPotentialProperties()

const dictionary & tetherPotentialProperties ( ) const
inline

Definition at line 134 of file tetherPotential.H.

References tetherPotentialProperties_.

Referenced by declareRunTimeSelectionTable(), harmonicSpring::harmonicSpring(), pitchForkRing::pitchForkRing(), read(), harmonicSpring::read(), pitchForkRing::read(), restrainedHarmonicSpring::read(), restrainedHarmonicSpring::restrainedHarmonicSpring(), tetherPotential(), harmonicSpring::TypeName(), pitchForkRing::TypeName(), and restrainedHarmonicSpring::TypeName().

Here is the caller graph for this function:

◆ read()

bool read ( const dictionary & tetherPotentialProperties)
pure virtual

Read tetherPotential dictionary.

Implemented in harmonicSpring, pitchForkRing, and restrainedHarmonicSpring.

Definition at line 48 of file tetherPotential.C.

References tetherPotentialProperties(), and tetherPotentialProperties_.

Referenced by harmonicSpring::read(), pitchForkRing::read(), and restrainedHarmonicSpring::read().

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

Member Data Documentation

◆ name_

word name_
protected

Definition at line 58 of file tetherPotential.H.

Referenced by tetherPotential().

◆ tetherPotentialProperties_

dictionary tetherPotentialProperties_
protected

Definition at line 59 of file tetherPotential.H.

Referenced by read(), tetherPotential(), and tetherPotentialProperties().

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