restrainedHarmonicSpring Class Reference

#include <restrainedHarmonicSpring.H>

Inheritance diagram for restrainedHarmonicSpring:

Collaboration diagram for restrainedHarmonicSpring:

Public Member Functions
	TypeName ("restrainedHarmonicSpring")
	Runtime type information.
	restrainedHarmonicSpring (const word &name, const dictionary &tetherPotentialProperties)
	Construct from components.
	~restrainedHarmonicSpring ()
	Destructor.
scalar	energy (const vector r) const
vector	force (const vector r) const
bool	read (const dictionary &tetherPotentialProperties)
	Read dictionary.
Public Member Functions inherited from tetherPotential
	TypeName ("tetherPotential")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, tetherPotential, dictionary,(const word &name, const dictionary &tetherPotentialProperties),(name, tetherPotentialProperties))
	tetherPotential (const word &name, const dictionary &tetherPotentialProperties)
	Construct from components.
virtual	~tetherPotential ()=default
	Destructor.
const dictionary &	tetherPotentialProperties () const

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

Detailed Description

Source files

• restrainedHarmonicSpring.H
• restrainedHarmonicSpring.C

Definition at line 48 of file restrainedHarmonicSpring.H.

Constructor & Destructor Documentation

restrainedHarmonicSpring()

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

Construct from components.

Definition at line 45 of file restrainedHarmonicSpring.C.

References Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, Foam::name(), tetherPotential::tetherPotential(), and tetherPotential::tetherPotentialProperties().

Here is the call graph for this function:

~restrainedHarmonicSpring()

~restrainedHarmonicSpring ( )

inline

Destructor.

Definition at line 84 of file restrainedHarmonicSpring.H.

Member Function Documentation

TypeName()

TypeName

(

"restrainedHarmonicSpring"

)

Runtime type information.

References Foam::name(), and tetherPotential::tetherPotentialProperties().

Here is the call graph for this function:

energy()

scalar energy ( const vector r ) const

virtual

Implements tetherPotential.

Definition at line 68 of file restrainedHarmonicSpring.C.

References Foam::mag(), and Foam::magSqr().

Here is the call graph for this function:

force()

vector force ( const vector r ) const

virtual

Implements tetherPotential.

Definition at line 84 of file restrainedHarmonicSpring.C.

References Foam::mag().

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 restrainedHarmonicSpring.C.

References Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, tetherPotential::read(), and tetherPotential::tetherPotentialProperties().

Here is the call graph for this function:

---

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

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