pitchForkRing Class Reference
Inheritance diagram for pitchForkRing:
[legend]
Collaboration diagram for pitchForkRing:
[legend]

Public Member Functions

 TypeName ("pitchForkRing")
 Runtime type information. More...
 
 pitchForkRing (const word &name, const dictionary &tetherPotentialProperties)
 Construct from components. More...
 
 ~pitchForkRing ()
 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...
 
virtual ~tetherPotential ()=default
 Destructor. More...
 
virtual scalar energy (const vector r) const =0
 
virtual vector force (const vector r) const =0
 
const dictionarytetherPotentialProperties () const
 
virtual bool read (const dictionary &tetherPotentialProperties)=0
 Read tetherPotential dictionary. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from tetherPotential
static autoPtr< tetherPotentialNew (const word &name, const dictionary &tetherPotentialProperties)
 Return a reference to the selected viscosity model. More...
 
- Protected Member Functions inherited from tetherPotential
 tetherPotential (const tetherPotential &)=delete
 No copy construct. More...
 
void operator= (const tetherPotential &)=delete
 No copy assignment. More...
 
- Protected Attributes inherited from tetherPotential
word name_
 
dictionary tetherPotentialProperties_
 

Detailed Description

Source files

Definition at line 52 of file pitchForkRing.H.

Constructor & Destructor Documentation

◆ pitchForkRing()

pitchForkRing ( const word name,
const dictionary tetherPotentialProperties 
)

Construct from components.

Definition at line 52 of file pitchForkRing.C.

◆ ~pitchForkRing()

~pitchForkRing ( )
inline

Destructor.

Definition at line 82 of file pitchForkRing.H.

Member Function Documentation

◆ TypeName()

TypeName ( "pitchForkRing"  )

Runtime type information.

◆ energy()

scalar energy ( const vector  r) const
virtual

Implements tetherPotential.

Definition at line 71 of file pitchForkRing.C.

References p, Foam::sqr(), Foam::sqrt(), Vector< Cmpt >::x(), Vector< Cmpt >::y(), and Vector< Cmpt >::z().

Here is the call graph for this function:

◆ force()

vector force ( const vector  r) const
virtual

Implements tetherPotential.

Definition at line 84 of file pitchForkRing.C.

References p, Foam::sqr(), Foam::sqrt(), Vector< Cmpt >::x(), Vector< Cmpt >::y(), and Vector< Cmpt >::z().

Here is the call graph for this function:

◆ read()

bool read ( const dictionary tetherPotentialProperties)
virtual

Read dictionary.

Implements tetherPotential.

Definition at line 99 of file pitchForkRing.C.

References kEpsilonLopesdaCosta< BasicTurbulenceModel >::read(), dictionary::readEntry(), dictionary::subDict(), and tetherPotential::tetherPotentialProperties().

Here is the call graph for this function:

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