harmonicSpring Class Reference

#include <harmonicSpring.H>

Inheritance diagram for harmonicSpring:

Collaboration diagram for harmonicSpring:

Public Member Functions
	TypeName ("harmonicSpring")
	Runtime type information.
	harmonicSpring (const word &name, const dictionary &tetherPotentialProperties)
	Construct from components.
	~harmonicSpring ()
	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

• harmonicSpring.H
• harmonicSpring.C

Definition at line 48 of file harmonicSpring.H.

Constructor & Destructor Documentation

harmonicSpring()

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

Construct from components.

Definition at line 45 of file harmonicSpring.C.

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

Here is the call graph for this function:

~harmonicSpring()

~harmonicSpring ( )

inline

Destructor.

Definition at line 82 of file harmonicSpring.H.

Member Function Documentation

TypeName()

TypeName

(

"harmonicSpring"

)

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 62 of file harmonicSpring.C.

References Foam::magSqr().

Here is the call graph for this function:

force()

vector force ( const vector r ) const

virtual

Implements tetherPotential.

Definition at line 68 of file harmonicSpring.C.

read()

bool read ( const dictionary & tetherPotentialProperties )

virtual

Read dictionary.

Implements tetherPotential.

Definition at line 74 of file harmonicSpring.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/harmonicSpring/harmonicSpring.H
• src/lagrangian/molecularDynamics/potential/tetherPotential/derived/harmonicSpring/harmonicSpring.C