tetherPotentialList Class Reference
Inheritance diagram for tetherPotentialList:
Collaboration diagram for tetherPotentialList:

Public Member Functions

 tetherPotentialList ()
 
 tetherPotentialList (const List< word > &siteIdList, const dictionary &tetherPotentialDict, const List< word > &tetherSiteIdList)
 Construct from siteIdList and potential dictionaries. More...
 
void operator= (const tetherPotentialList &)=delete
 Disallow default bitwise assignment. 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
 
 tetherPotentialList (const tetherPotentialList &)=delete
 Disallow default bitwise copy construction. More...
 
- 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 (PtrList< tetherPotential > &&)
 Move constructor. 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...
 
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...
 
bool set (const label) const
 Is element set. More...
 
autoPtr< tetherPotentialset (const label, tetherPotential *)
 Set element to given T* and return old element (can be nullptr) More...
 
autoPtr< tetherPotentialset (const label, const autoPtr< tetherPotential > &)
 Set element to given autoPtr<T> and return old element. More...
 
autoPtr< tetherPotentialset (const label, const tmp< tetherPotential > &)
 Set element to given tmp<T> and return old element. More...
 
void reorder (const labelUList &oldToNew)
 Reorders elements. Ordering does not have to be done in. More...
 
void shuffle (const labelUList &newToOld)
 Reorders elements. Ordering does not have to be done in. More...
 
void operator= (const PtrList< tetherPotential > &)
 Assignment operator. More...
 
void operator= (PtrList< tetherPotential > &&)
 Move assignment operator. More...
 
- Public Member Functions inherited from UPtrList< T >
 UPtrList ()
 Null Constructor. More...
 
 UPtrList (const label)
 Construct with size specified. More...
 
 UPtrList (UPtrList< T > &, bool reuse)
 Construct as copy or re-use as specified. More...
 
label size () const
 Return the number of elements in the UPtrList. More...
 
bool empty () const
 Return true if the UPtrList is empty (ie, size() is zero) More...
 
Tfirst ()
 Return reference to the first element of the list. More...
 
const Tfirst () const
 Return reference to first element of the list. More...
 
Tlast ()
 Return reference to the last element of the list. More...
 
const Tlast () const
 Return reference to the last element of the list. More...
 
void setSize (const label)
 Reset size of UPtrList. This can only be used to set the size. More...
 
void resize (const label)
 Reset size of UPtrList. This can only be used to set the size. More...
 
void clear ()
 Clear the UPtrList, i.e. set size to zero. More...
 
void transfer (UPtrList< T > &)
 Transfer the contents of the argument UPtrList into this. More...
 
bool set (const label) const
 Is element set. More...
 
Tset (const label, T *)
 Set element. Return old element (can be nullptr). More...
 
void reorder (const labelUList &oldToNew)
 Reorders elements. Ordering does not have to be done in. More...
 
void shuffle (const labelUList &newToOld)
 Reorders elements. Ordering does not have to be done in. More...
 
template<class T2 >
UPtrList< T2 > convert ()
 Convert to list of different pointer type. More...
 
template<class T2 >
UPtrList< const T2 > convert () const
 Convert to list of different pointer type. More...
 
const Toperator[] (const label) const
 Return element const reference. More...
 
Toperator[] (const label)
 Return element reference. More...
 
const Toperator() (const label) const
 Return element const pointer. More...
 
iterator begin ()
 Return an iterator to begin traversing the UPtrList. More...
 
iterator end ()
 Return an iterator to end traversing the UPtrList. More...
 
const_iterator cbegin () const
 Return an const_iterator to begin traversing the UPtrList. More...
 
const_iterator cend () const
 Return an const_iterator to end traversing the UPtrList. More...
 
const_iterator begin () const
 Return an const_iterator to begin traversing the UPtrList. More...
 
const_iterator end () const
 Return an const_iterator to end traversing the UPtrList. More...
 
template<class T2 >
Foam::UPtrList< T2 > convert ()
 
template<class T2 >
Foam::UPtrList< const T2 > convert () const
 

Additional Inherited Members

- Public Types inherited from UPtrList< T >
typedef T value_type
 Type of values the UPtrList contains. More...
 
typedef Treference
 Type that can be used for storing into UPtrList::value_type objects. More...
 
typedef const Tconst_reference
 Type that can be used for storing into constant UPtrList::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

◆ tetherPotentialList() [1/3]

Definition at line 87 of file tetherPotentialList.C.

◆ tetherPotentialList() [2/3]

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

Construct from siteIdList and potential dictionaries.

Definition at line 95 of file tetherPotentialList.C.

References tetherPotentialList::buildPotentials().

Here is the call graph for this function:

◆ ~tetherPotentialList()

Destructor.

Definition at line 110 of file tetherPotentialList.C.

References tetherPotentialList::buildPotentials().

Here is the call graph for this function:

◆ tetherPotentialList() [3/3]

Disallow default bitwise copy construction.

Member Function Documentation

◆ operator=()

void operator= ( const tetherPotentialList )
delete

Disallow default bitwise assignment.

◆ buildPotentials()

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:

◆ idMap()

const List<word>& idMap ( ) const
inline

◆ tetherPotentialFunction()

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:

◆ force()

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:

◆ energy()

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: