tetherPotentialList Class Reference
Inheritance diagram for tetherPotentialList:
[legend]
Collaboration diagram for tetherPotentialList:
[legend]

Public Member Functions

 tetherPotentialList ()
 
 tetherPotentialList (const List< word > &siteIdList, const dictionary &tetherPotentialDict, const List< word > &tetherSiteIdList)
 Construct from siteIdList and potential 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 >
constexpr PtrList () noexcept
 Default construct. More...
 
 PtrList (const label len)
 Construct with specified size, each element initialized to nullptr. More...
 
 PtrList (const PtrList< tetherPotential > &list)
 Copy construct using 'clone()' method on each element. More...
 
 PtrList (PtrList< tetherPotential > &&list)
 Move construct. More...
 
 PtrList (UList< tetherPotential * > &list)
 Take ownership of pointers in the list, set old pointers to null. More...
 
 PtrList (const PtrList< tetherPotential > &list, const CloneArg &cloneArgs)
 Copy construct using 'clone()' method on each element. More...
 
 PtrList (PtrList< tetherPotential > &list, bool reuse)
 Construct as copy or re-use as specified. More...
 
 PtrList (const SLPtrList< tetherPotential > &list)
 Copy construct using 'clone()' on each element of SLPtrList<T> More...
 
 PtrList (Istream &is, const INew &inew)
 Construct from Istream using given Istream constructor class. More...
 
 PtrList (Istream &is)
 Construct from Istream using default Istream constructor class. More...
 
 ~PtrList ()
 Destructor. More...
 
PtrList< tetherPotentialclone (Args &&... args) const
 Make a copy by cloning each of the list elements. More...
 
Foam::PtrList< tetherPotentialclone (Args &&... args) const
 
const tetherPotentialset (const label i) const
 Return const pointer to element (can be nullptr),. More...
 
autoPtr< tetherPotentialset (const label i, tetherPotential *ptr)
 Set element to given pointer and return old element (can be null) More...
 
autoPtr< tetherPotentialset (const label i, autoPtr< tetherPotential > &ptr)
 Set element to given autoPtr and return old element. More...
 
autoPtr< tetherPotentialset (const label i, autoPtr< tetherPotential > &&ptr)
 Set element to given autoPtr and return old element. More...
 
autoPtr< tetherPotentialset (const label i, std::unique_ptr< tetherPotential > &&ptr)
 Set element to given unique_ptr and return old element. More...
 
autoPtr< tetherPotentialset (const label i, const refPtr< tetherPotential > &ptr)
 Set element to given refPtr and return old element. More...
 
autoPtr< tetherPotentialset (const label i, const tmp< tetherPotential > &ptr)
 Set element to given tmp and return old element. More...
 
void clear ()
 Clear the PtrList. Delete allocated entries and set size to zero. More...
 
void resize (const label newLen)
 Adjust size of PtrList. More...
 
void setSize (const label newLen)
 Same as resize() More...
 
void emplace_append (Args &&... args)
 Construct and append an element to the end of the list. More...
 
void append (tetherPotential *ptr)
 Append an element to the end of the list. More...
 
void append (autoPtr< tetherPotential > &ptr)
 Move append an element to the end of the list. More...
 
void append (autoPtr< tetherPotential > &&ptr)
 Move append an element to the end of the list. More...
 
void append (std::unique_ptr< tetherPotential > &&ptr)
 Move append an element to the end of the list. More...
 
void append (const refPtr< tetherPotential > &ptr)
 Move or clone append a refPtr to the end of the list. More...
 
void append (const tmp< tetherPotential > &ptr)
 Move or clone append a tmp to the end of the list. More...
 
autoPtr< tetherPotentialemplace (const label i, Args &&... args)
 Construct and set an element. More...
 
Foam::autoPtr< tetherPotentialemplace (const label i, Args &&... args)
 
autoPtr< tetherPotentialrelease (const label i)
 Release ownership of the pointer at the given position. More...
 
void transfer (PtrList< tetherPotential > &list)
 Transfer into this list and annul the argument list. More...
 
void operator= (const PtrList< tetherPotential > &list)
 Copy assignment. More...
 
void operator= (PtrList< tetherPotential > &&list)
 Move assignment. More...
 

Additional Inherited Members

- Protected Member Functions inherited from PtrList< tetherPotential >
void readIstream (Istream &is, const INew &inew)
 Read from Istream using Istream constructor class. More...
 
void free ()
 Delete the allocated entries, but retain the list size. More...
 

Detailed Description

Source files

Definition at line 52 of file tetherPotentialList.H.

Constructor & Destructor Documentation

◆ tetherPotentialList() [1/2]

Definition at line 89 of file tetherPotentialList.C.

◆ tetherPotentialList() [2/2]

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

Construct from siteIdList and potential dictionaries.

Definition at line 97 of file tetherPotentialList.C.

◆ ~tetherPotentialList()

Destructor.

Definition at line 112 of file tetherPotentialList.C.

Member Function Documentation

◆ buildPotentials()

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

Definition at line 119 of file tetherPotentialList.C.

References setSize().

Here is the call graph for this function:

◆ idMap()

const List<word>& idMap ( ) const
inline

◆ tetherPotentialFunction()

const Foam::tetherPotential & tetherPotentialFunction ( const label  a) const

Definition at line 132 of file tetherPotentialList.C.

◆ force()

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

Definition at line 141 of file tetherPotentialList.C.

◆ energy()

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

Definition at line 151 of file tetherPotentialList.C.


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