Public Member Functions | List of all members
tetherPotentialList Class Reference
Inheritance diagram for tetherPotentialList:
Inheritance graph
[legend]
Collaboration diagram for tetherPotentialList:
Collaboration graph
[legend]

Public Member Functions

 tetherPotentialList ()
 
 tetherPotentialList (const List< word > &siteIdList, const dictionary &tetherPotentialDict, const List< word > &tetherSiteIdList)
 Construct from siteIdList and potental dictionaries. More...
 
 ~tetherPotentialList ()
 Destructor. More...
 
void buildPotentials (const List< word > &siteIdList, const dictionary &tetherPotentialDict, const List< word > &tetherSiteIdList)
 
const List< word > & idMap () const
 
const tetherPotentialtetherPotentialFunction (const label a) const
 
vector force (const label a, const vector rIT) const
 
scalar energy (const label a, const vector rIT) const
 
- Public Member Functions inherited from PtrList< tetherPotential >
 PtrList ()
 Null Constructor. More...
 
 PtrList (const label)
 Construct with size specified. More...
 
 PtrList (const PtrList< tetherPotential > &)
 Copy constructor. More...
 
 PtrList (const PtrList< tetherPotential > &, const CloneArg &)
 Copy constructor with additional argument for clone. More...
 
 PtrList (const Xfer< PtrList< tetherPotential > > &)
 Construct by transferring the parameter contents. More...
 
 PtrList (PtrList< tetherPotential > &, bool reUse)
 Construct as copy or re-use as specified. More...
 
 PtrList (const SLPtrList< tetherPotential > &)
 Construct as copy of SLPtrList<T> More...
 
 PtrList (Istream &, const INew &)
 Construct from Istream using given Istream constructor class. More...
 
 PtrList (Istream &)
 Construct from Istream using default Istream constructor class. More...
 
 ~PtrList ()
 Destructor. More...
 
label size () const
 Return the number of elements in the PtrList. More...
 
bool empty () const
 Return true if the PtrList is empty (ie, size() is zero). More...
 
tetherPotentialfirst ()
 Return reference to the first element of the list. More...
 
const tetherPotentialfirst () const
 Return reference to first element of the list. More...
 
tetherPotentiallast ()
 Return reference to the last element of the list. More...
 
const tetherPotentiallast () const
 Return reference to the last element of the list. More...
 
void setSize (const label)
 Reset size of PtrList. If extending the PtrList, new entries are. More...
 
void resize (const label)
 Alias for setSize(const label) More...
 
void clear ()
 Clear the PtrList, i.e. set size to zero deleting all the. More...
 
void append (tetherPotential *)
 Append an element at the end of the list. More...
 
void append (const autoPtr< tetherPotential > &)
 
void append (const tmp< tetherPotential > &)
 
void transfer (PtrList< tetherPotential > &)
 Transfer the contents of the argument PtrList into this PtrList. More...
 
Xfer< PtrList< tetherPotential > > xfer ()
 Transfer contents to the Xfer container. More...
 
bool set (const label) const
 Is element set. More...
 
autoPtr< tetherPotentialset (const label, tetherPotential *)
 Set element. Return old element (can be NULL). More...
 
autoPtr< tetherPotentialset (const label, const autoPtr< tetherPotential > &)
 
autoPtr< tetherPotentialset (const label, const tmp< tetherPotential > &)
 
void reorder (const labelUList &)
 Reorders elements. Ordering does not have to be done in. More...
 
const tetherPotentialoperator[] (const label) const
 Return element const reference. More...
 
tetherPotentialoperator[] (const label)
 Return element reference. More...
 
const tetherPotentialoperator() (const label) const
 Return element const pointer. More...
 
PtrList< tetherPotential > & operator= (const PtrList< tetherPotential > &)
 Assignment. More...
 
iterator begin ()
 Return an iterator to begin traversing the PtrList. More...
 
const_iterator begin () const
 Return an const_iterator to begin traversing the PtrList. More...
 
iterator end ()
 Return an iterator to end traversing the PtrList. More...
 
const_iterator end () const
 Return an const_iterator to end traversing the PtrList. More...
 
const_iterator cbegin () const
 Return an const_iterator to begin traversing the PtrList. More...
 
const_iterator cend () const
 Return an const_iterator to end traversing the PtrList. More...
 

Additional Inherited Members

- Public Types inherited from PtrList< tetherPotential >
typedef tetherPotential value_type
 Type of values the PtrList contains. More...
 
typedef tetherPotentialreference
 Type that can be used for storing into PtrList::value_type objects. More...
 
typedef const tetherPotentialconst_reference
 Type that can be used for storing into constant PtrList::value_type. More...
 
- Protected Member Functions inherited from PtrList< tetherPotential >
void read (Istream &, const INew &inewt)
 Read from Istream using given Istream constructor class. More...
 

Detailed Description

Source files

Definition at line 50 of file tetherPotentialList.H.

Constructor & Destructor Documentation

Definition at line 87 of file tetherPotentialList.C.

tetherPotentialList ( const List< word > &  siteIdList,
const dictionary tetherPotentialDict,
const List< word > &  tetherSiteIdList 
)

Construct from siteIdList and potental dictionaries.

Definition at line 95 of file tetherPotentialList.C.

References tetherPotentialList::buildPotentials().

Here is the call graph for this function:

Destructor.

Definition at line 110 of file tetherPotentialList.C.

References tetherPotentialList::buildPotentials().

Here is the call graph for this function:

Member Function Documentation

void buildPotentials ( const List< word > &  siteIdList,
const dictionary tetherPotentialDict,
const List< word > &  tetherSiteIdList 
)

Definition at line 117 of file tetherPotentialList.C.

References PtrList< tetherPotential >::setSize(), List< T >::size(), and tetherPotentialList::tetherPotentialFunction().

Referenced by tetherPotentialList::tetherPotentialList(), and tetherPotentialList::~tetherPotentialList().

Here is the call graph for this function:

Here is the caller graph for this function:

const List<word>& idMap ( ) const
inline
const Foam::tetherPotential & tetherPotentialFunction ( const label  a) const

Definition at line 130 of file tetherPotentialList.C.

References tetherPotentialList::force().

Referenced by tetherPotentialList::buildPotentials().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::vector force ( const label  a,
const vector  rIT 
) const

Definition at line 139 of file tetherPotentialList.C.

References tetherPotentialList::energy().

Referenced by tetherPotentialList::tetherPotentialFunction().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::scalar energy ( const label  a,
const vector  rIT 
) const

Definition at line 149 of file tetherPotentialList.C.

Referenced by tetherPotentialList::force().

Here is the caller graph for this function:


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