Public Member Functions | List of all members
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

Definition at line 51 of file potential.H.

Constructor & Destructor Documentation

◆ potential() [1/2]

potential ( const polyMesh &  mesh)

Construct from mesh reference.

Definition at line 349 of file potential.C.

◆ potential() [2/2]

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

Construct from mdInitialiseDict.

Definition at line 358 of file potential.C.

◆ ~potential()

~potential ( )

Destructor.

Definition at line 371 of file potential.C.

Member Function Documentation

◆ nIds()

Foam::label nIds ( ) const
inline

Definition at line 23 of file potentialI.H.

References UList< T >::size().

Here is the call graph for this function:

◆ idList()

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

Definition at line 29 of file potentialI.H.

◆ siteIdList()

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

Definition at line 35 of file potentialI.H.

◆ potentialEnergyLimit()

Foam::scalar potentialEnergyLimit ( ) const
inline

Definition at line 41 of file potentialI.H.

◆ nPairPotentials()

Foam::label nPairPotentials ( ) const
inline

Definition at line 47 of file potentialI.H.

◆ removalOrder()

const Foam::labelList & removalOrder ( ) const
inline

Definition at line 53 of file potentialI.H.

◆ pairPotentials()

const Foam::pairPotentialList & pairPotentials ( ) const
inline

Definition at line 59 of file potentialI.H.

◆ tetherPotentials()

const Foam::tetherPotentialList & tetherPotentials ( ) const
inline

Definition at line 66 of file potentialI.H.

◆ gravity()

const Foam::vector & gravity ( ) const
inline

Definition at line 72 of file potentialI.H.

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