tetherPotential Class Reference

Inheritance diagram for tetherPotential:

Collaboration diagram for tetherPotential:

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 ()
	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 &)
	Disallow copy construct. More...
void	operator= (const tetherPotential &)
	Disallow default bitwise assignment. More...

Protected Attributes
word	name_
dictionary	tetherPotentialProperties_

Detailed Description

Source files

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

Definition at line 52 of file tetherPotential.H.

Constructor & Destructor Documentation

tetherPotential ( const tetherPotential &  )

protected

Disallow copy construct.

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

Construct from components.

Definition at line 40 of file tetherPotential.C.

virtual ~tetherPotential ( )

inlinevirtual

Destructor.

Definition at line 114 of file tetherPotential.H.

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

Here is the call graph for this function:

Member Function Documentation

void operator= ( const tetherPotential &  )

protected

Disallow default bitwise assignment.

TypeName

(

"tetherPotential"

)

Runtime type information.

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

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:

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:

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:

const dictionary& tetherPotentialProperties ( ) const

inline

Definition at line 124 of file tetherPotential.H.

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

Here is the call graph for this function:

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:

Member Data Documentation

word name_

protected

Definition at line 59 of file tetherPotential.H.

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:

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