restrainedHarmonicSpring Class Reference

Inheritance diagram for restrainedHarmonicSpring:

Collaboration diagram for restrainedHarmonicSpring:

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

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

• restrainedHarmonicSpring.H
• restrainedHarmonicSpring.C

Definition at line 50 of file restrainedHarmonicSpring.H.

Constructor & Destructor Documentation

restrainedHarmonicSpring()

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

Construct from components.

Definition at line 51 of file restrainedHarmonicSpring.C.

~restrainedHarmonicSpring()

~restrainedHarmonicSpring ( )

inline

Destructor.

Definition at line 80 of file restrainedHarmonicSpring.H.

Member Function Documentation

TypeName()

TypeName

(

"restrainedHarmonicSpring"

)

Runtime type information.

energy()

scalar energy ( const vector  r ) const

virtual

Implements tetherPotential.

Definition at line 73 of file restrainedHarmonicSpring.C.

References Foam::mag(), Foam::magSqr(), restrainedHarmonicSpring::rR_, and restrainedHarmonicSpring::springConstant_.

Here is the call graph for this function:

force()

vector force ( const vector  r ) const

virtual

Implements tetherPotential.

Definition at line 89 of file restrainedHarmonicSpring.C.

References Foam::mag(), restrainedHarmonicSpring::rR_, and restrainedHarmonicSpring::springConstant_.

Here is the call graph for this function:

read()

bool read ( const dictionary &  tetherPotentialProperties )

virtual

Read dictionary.

Implements tetherPotential.

Definition at line 105 of file restrainedHarmonicSpring.C.

References dictionary::lookup(), tetherPotential::read(), and dictionary::subDict().

Here is the call graph for this function:

Field Documentation

restrainedHarmonicSpringCoeffs_

dictionary restrainedHarmonicSpringCoeffs_

private

Definition at line 56 of file restrainedHarmonicSpring.H.

springConstant_

scalar springConstant_

private

Definition at line 58 of file restrainedHarmonicSpring.H.

Referenced by restrainedHarmonicSpring::energy(), and restrainedHarmonicSpring::force().

rR_

scalar rR_

private

Definition at line 60 of file restrainedHarmonicSpring.H.

Referenced by restrainedHarmonicSpring::energy(), and restrainedHarmonicSpring::force().

---

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