Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
tetherPotential Class Referenceabstract
Inheritance diagram for tetherPotential:
Inheritance graph
[legend]
Collaboration diagram for tetherPotential:
Collaboration graph
[legend]

Public Member Functions

 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...
 
virtual ~tetherPotential ()=default
 Destructor. More...
 
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. More...
 

Static Public Member Functions

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

Protected Member Functions

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

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.

◆ tetherPotential() [2/2]

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

Construct from components.

Definition at line 35 of file tetherPotential.C.

◆ ~tetherPotential()

virtual ~tetherPotential ( )
virtualdefault

Destructor.

Member Function Documentation

◆ operator=()

void operator= ( const tetherPotential &  )
protecteddelete

No copy assignment.

◆ TypeName()

TypeName ( "tetherPotential"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

◆ New()

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

Return a reference to the selected viscosity model.

Definition at line 27 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 pitchForkRing, restrainedHarmonicSpring, and harmonicSpring.

◆ force()

virtual vector force ( const vector  r) const
pure virtual

Implemented in pitchForkRing, restrainedHarmonicSpring, and harmonicSpring.

◆ tetherPotentialProperties()

const dictionary& tetherPotentialProperties ( ) const
inline

Definition at line 134 of file tetherPotential.H.

References tetherPotential::tetherPotentialProperties_.

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

Here is the caller graph for this function:

◆ read()

bool read ( const dictionary &  tetherPotentialProperties)
pure virtual

Read tetherPotential dictionary.

Implemented in pitchForkRing, restrainedHarmonicSpring, and harmonicSpring.

Definition at line 48 of file tetherPotential.C.

References tetherPotential::tetherPotentialProperties(), and tetherPotential::tetherPotentialProperties_.

Referenced by harmonicSpring::read(), restrainedHarmonicSpring::read(), and pitchForkRing::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.

◆ tetherPotentialProperties_

dictionary tetherPotentialProperties_
protected

Definition at line 59 of file tetherPotential.H.

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

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