Public Member Functions | Static Public 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...
 
 tetherPotential (const tetherPotential &)
 Disallow default bitwise copy construction. More...
 
virtual ~tetherPotential ()
 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...
 
void operator= (const tetherPotential &)=delete
 Disallow default bitwise assignment. 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 Attributes

word name_
 
dictionary tetherPotentialProperties_
 

Detailed Description

Source files

Definition at line 52 of file tetherPotential.H.

Constructor & Destructor Documentation

◆ tetherPotential() [1/2]

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

Construct from components.

Definition at line 40 of file tetherPotential.C.

◆ tetherPotential() [2/2]

tetherPotential ( const tetherPotential &  )

Disallow default bitwise copy construction.

◆ ~tetherPotential()

virtual ~tetherPotential ( )
inlinevirtual

Destructor.

Definition at line 108 of file tetherPotential.H.

References tetherPotential::energy(), and tetherPotential::force().

Here is the call graph for this function:

Member Function Documentation

◆ 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 31 of file tetherPotentialNew.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, dictionary::lookup(), 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.

Referenced by tetherPotential::~tetherPotential().

Here is the caller graph for this function:

◆ force()

virtual vector force ( const vector  r) const
pure virtual

Implemented in pitchForkRing, restrainedHarmonicSpring, and harmonicSpring.

Referenced by tetherPotential::~tetherPotential().

Here is the caller graph for this function:

◆ tetherPotentialProperties()

const dictionary& tetherPotentialProperties ( ) const
inline

Definition at line 118 of file tetherPotential.H.

References tetherPotential::operator=(), tetherPotential::read(), and tetherPotential::tetherPotentialProperties_.

Here is the call graph for this function:

◆ read()

bool read ( const dictionary &  tetherPotentialProperties)
pure virtual

Read tetherPotential dictionary.

Implemented in pitchForkRing, restrainedHarmonicSpring, and harmonicSpring.

Definition at line 53 of file tetherPotential.C.

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

Here is the caller graph for this function:

◆ operator=()

void operator= ( const tetherPotential &  )
delete

Disallow default bitwise assignment.

Referenced by tetherPotential::tetherPotentialProperties().

Here is the caller graph for this function:

Member Data Documentation

◆ name_

word name_
protected

Definition at line 59 of file tetherPotential.H.

◆ tetherPotentialProperties_

dictionary tetherPotentialProperties_
protected

Definition at line 60 of file tetherPotential.H.

Referenced by tetherPotential::tetherPotentialProperties().

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