pitchForkRing Class Reference

Inheritance diagram for pitchForkRing:

Collaboration diagram for pitchForkRing:

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 ()
	Destructor. More...
const dictionary &	tetherPotentialProperties () const

Private Attributes
dictionary	pitchForkRingCoeffs_
scalar	mu_
scalar	alpha_
scalar	rOrbit_

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 Member Functions inherited from tetherPotential
	tetherPotential (const tetherPotential &)
	Disallow copy construct. More...
void	operator= (const tetherPotential &)
	Disallow default bitwise assignment. More...
Protected Attributes inherited from tetherPotential
word	name_
dictionary	tetherPotentialProperties_

Detailed Description

Source files

• pitchForkRing.H
• pitchForkRing.C

Definition at line 50 of file pitchForkRing.H.

Constructor & Destructor Documentation

pitchForkRing()

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

Construct from components.

Definition at line 51 of file pitchForkRing.C.

~pitchForkRing()

~pitchForkRing ( )

inline

Destructor.

Definition at line 80 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 69 of file pitchForkRing.C.

References pitchForkRing::alpha_, pitchForkRing::mu_, p, pitchForkRing::rOrbit_, 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 82 of file pitchForkRing.C.

References pitchForkRing::alpha_, pitchForkRing::mu_, p, pitchForkRing::rOrbit_, 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 97 of file pitchForkRing.C.

References pitchForkRing::alpha_, dictionary::lookup(), pitchForkRing::mu_, pitchForkRing::pitchForkRingCoeffs_, tetherPotential::read(), pitchForkRing::rOrbit_, dictionary::subDict(), and tetherPotential::tetherPotentialProperties().

Here is the call graph for this function:

Field Documentation

pitchForkRingCoeffs_

dictionary pitchForkRingCoeffs_

private

Definition at line 56 of file pitchForkRing.H.

Referenced by pitchForkRing::read().

mu_

scalar mu_

private

Definition at line 58 of file pitchForkRing.H.

Referenced by pitchForkRing::energy(), pitchForkRing::force(), and pitchForkRing::read().

alpha_

scalar alpha_

private

Definition at line 59 of file pitchForkRing.H.

Referenced by pitchForkRing::energy(), pitchForkRing::force(), and pitchForkRing::read().

rOrbit_

scalar rOrbit_

private

Definition at line 60 of file pitchForkRing.H.

Referenced by pitchForkRing::energy(), pitchForkRing::force(), and pitchForkRing::read().

---

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

• src/lagrangian/molecularDynamics/potential/tetherPotential/derived/pitchForkRing/pitchForkRing.H
• src/lagrangian/molecularDynamics/potential/tetherPotential/derived/pitchForkRing/pitchForkRing.C