FreeFOAM The Cross-Platform CFD Toolkit
tetherPotentialList Class Reference

#include <potential/tetherPotentialList.H>


Detailed Description

+ Inheritance diagram for tetherPotentialList:
+ Collaboration diagram for tetherPotentialList:

List of all members.

Public Member Functions

 tetherPotentialList ()
 tetherPotentialList (const List< word > &siteIdList, const dictionary &tetherPotentialDict, const List< word > &tetherSiteIdList)
 Construct from siteIdList and potental dictionaries.
 ~tetherPotentialList ()
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.
 PtrList (const label)
 Construct with length specified.
 PtrList (const PtrList< tetherPotential > &)
 Copy constructor.
 PtrList (const PtrList< tetherPotential > &, const CloneArg &)
 Copy constructor with additional argument for clone.
 PtrList (const Xfer< PtrList< tetherPotential > > &)
 Construct by transferring the parameter contents.
 PtrList (PtrList< tetherPotential > &, bool reUse)
 Construct as copy or re-use as specified.
 PtrList (const SLPtrList< tetherPotential > &)
 Construct as copy of SLPtrList<T>
 PtrList (Istream &, const INew &)
 Construct from Istream using given Istream constructor class.
 PtrList (Istream &)
 Construct from Istream using default Istream constructor class.
 ~PtrList ()
label size () const
 Return the number of elements in the PtrList.
bool empty () const
 Return true if the PtrList is empty (ie, size() is zero).
void setSize (const label)
 Reset size of PtrList. This can only be used to set the size.
void resize (const label)
 Reset size of PtrList. This can only be used to set the size.
void clear ()
 Clear the PtrList, i.e. set size to zero deleting all the.
void transfer (PtrList< tetherPotential > &)
 Transfer the contents of the argument PtrList into this PtrList.
Xfer< PtrList< tetherPotential > > xfer ()
 Transfer contents to the Xfer container.
bool set (const label) const
 Is element set.
autoPtr< tetherPotentialset (const label, tetherPotential *)
 Set element. Return old element (can be NULL).
autoPtr< tetherPotentialset (const label, const autoPtr< tetherPotential > &)
autoPtr< tetherPotentialset (const label, const tmp< tetherPotential > &)
void reorder (const UList< label > &)
 Reorders elements. Ordering does not have to be done in.
const tetherPotentialoperator[] (const label) const
 Return element const reference.
tetherPotentialoperator[] (const label)
 Return element reference.
const tetherPotentialoperator() (const label) const
 Return element const pointer.
PtrList< tetherPotential > & operator= (const PtrList< tetherPotential > &)
 Assignment.
iterator begin ()
 Return an iterator to begin traversing the PtrList.
iterator end ()
 Return an iterator to end traversing the PtrList.

Additional Inherited Members

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

Constructor & Destructor Documentation

Definition at line 86 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 94 of file tetherPotentialList.C.

Definition at line 109 of file tetherPotentialList.C.


Member Function Documentation

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

Definition at line 116 of file tetherPotentialList.C.

References setSize(), and List< T >::size().

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

Definition at line 129 of file tetherPotentialList.C.

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

Definition at line 138 of file tetherPotentialList.C.

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

Definition at line 148 of file tetherPotentialList.C.


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