potential Class Reference

Public Member Functions
	potential (const polyMesh &mesh)
	Construct from mesh reference. More...
	potential (const polyMesh &mesh, const IOdictionary &mdInitialiseDict, IOdictionary &idListDict)
	Construct from mdInitialiseDict. More...
	~potential ()
	Destructor. More...
label	nIds () const
const List< word > &	idList () const
const List< word > &	siteIdList () const
scalar	potentialEnergyLimit () const
label	nPairPotentials () const
const labelList &	removalOrder () const
const pairPotentialList &	pairPotentials () const
const tetherPotentialList &	tetherPotentials () const
const vector &	gravity () const

Detailed Description

Source files

• potential.H
• potentialI.H
• potential.C

Definition at line 53 of file potential.H.

Constructor & Destructor Documentation

potential

(

const polyMesh &

mesh

)

Construct from mesh reference.

Definition at line 354 of file potential.C.

potential	(	const polyMesh &	mesh,
		const IOdictionary &	mdInitialiseDict,
		IOdictionary &	idListDict
	)

Construct from mdInitialiseDict.

Definition at line 363 of file potential.C.

~potential

(

)

Destructor.

Definition at line 376 of file potential.C.

Member Function Documentation

Foam::label nIds ( ) const

inline

Definition at line 28 of file potentialI.H.

References List< T >::size().

Here is the call graph for this function:

const Foam::List< Foam::word > & idList ( ) const

inline

Definition at line 34 of file potentialI.H.

const Foam::List< Foam::word > & siteIdList ( ) const

inline

Definition at line 40 of file potentialI.H.

Foam::scalar potentialEnergyLimit ( ) const

inline

Definition at line 46 of file potentialI.H.

Foam::label nPairPotentials ( ) const

inline

Definition at line 52 of file potentialI.H.

References UPtrList< T >::size().

Here is the call graph for this function:

const Foam::labelList & removalOrder ( ) const

inline

Definition at line 58 of file potentialI.H.

const Foam::pairPotentialList & pairPotentials ( ) const

inline

Definition at line 64 of file potentialI.H.

const Foam::tetherPotentialList & tetherPotentials ( ) const

inline

Definition at line 71 of file potentialI.H.

const Foam::vector & gravity ( ) const

inline

Definition at line 77 of file potentialI.H.

---

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

• src/lagrangian/molecularDynamics/potential/potential/potential.H
• src/lagrangian/molecularDynamics/potential/potential/potential.C
• src/lagrangian/molecularDynamics/potential/potential/potentialI.H