tetherPotential Class Reference

Inheritance diagram for tetherPotential:

Collaboration diagram for tetherPotential:

Public Member Functions
	TypeName ("tetherPotential")
	declareRunTimeSelectionTable (autoPtr, tetherPotential, dictionary,(const word &name, const dictionary &tetherPotentialProperties),(name, tetherPotentialProperties))
	tetherPotential (const word &name, const dictionary &tetherPotentialProperties)
virtual	~tetherPotential ()=default
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

Static Public Member Functions
static autoPtr< tetherPotential >	New (const word &name, const dictionary &tetherPotentialProperties)

Protected Member Functions
	tetherPotential (const tetherPotential &)=delete
void	operator= (const tetherPotential &)=delete

Protected Attributes
word	name_
dictionary	tetherPotentialProperties_

Detailed Description

Source files

• tetherPotential.H
• tetherPotential.C
• tetherPotentialNew.C

Definition at line 51 of file tetherPotential.H.

Constructor & Destructor Documentation

tetherPotential() [1/2]

tetherPotential ( const tetherPotential &  )

protecteddelete

tetherPotential() [2/2]

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

Definition at line 35 of file tetherPotential.C.

~tetherPotential()

virtual ~tetherPotential ( )

virtualdefault

Member Function Documentation

operator=()

void operator= ( const tetherPotential &  )

protecteddelete

TypeName()

TypeName

(

"tetherPotential"

)

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

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 122 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

Implemented in pitchForkRing, restrainedHarmonicSpring, and harmonicSpring.

Definition at line 48 of file tetherPotential.C.

References tetherPotential::tetherPotentialProperties(), and tetherPotential::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.

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:

• src/lagrangian/molecularDynamics/potential/tetherPotential/basic/tetherPotential.H
• src/lagrangian/molecularDynamics/potential/tetherPotential/basic/tetherPotential.C
• src/lagrangian/molecularDynamics/potential/tetherPotential/basic/tetherPotentialNew.C