#include <tetherPotentialList.H>
Public Member Functions | |
| tetherPotentialList () | |
| tetherPotentialList (const List< word > &siteIdList, const dictionary &tetherPotentialDict, const List< word > &tetherSiteIdList) | |
| Construct from siteIdList and potential dictionaries. | |
| ~tetherPotentialList () | |
| Destructor. | |
| void | buildPotentials (const List< word > &siteIdList, const dictionary &tetherPotentialDict, const List< word > &tetherSiteIdList) |
| const List< word > & | idMap () const |
| const tetherPotential & | tetherPotentialFunction (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 > | |
| Foam::PtrList< tetherPotential > | clone (Args &&... args) const |
| constexpr | PtrList () noexcept |
| Default construct. | |
| ~PtrList () | |
| Destructor. Frees all pointers. | |
| const tetherPotential * | set (const label i) const |
| Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). | |
| void | clear () |
| Clear the PtrList. Delete allocated entries and set size to zero. | |
| void | free () |
| Free memory and nullify all entries. Does not change the list size. | |
| void | resize (const label newLen) |
| Adjust size of PtrList. | |
| void | resize_null (const label newLen) |
Set the addressed list to the given size, deleting all existing entries. Afterwards the list contains all nullptr entries. | |
| tetherPotential & | emplace_back (Args &&... args) |
| Construct and append an element to the end of the list, return reference to the new list element. | |
| void | push_back (tetherPotential *ptr) |
| Append an element to the end of the list. | |
| tetherPotential & | emplace_set (const label i, Args &&... args) |
| Construct and set a new element at given position, (discard old element at that location). | |
| tetherPotential & | emplace (const label i, Args &&... args) |
| Same as emplace_set(). | |
| tetherPotential & | try_emplace (const label i, Args &&... args) |
| Like emplace_set() but will not overwrite an occupied (non-null) location. | |
| autoPtr< tetherPotential > | release (const label i) |
| Release ownership of the pointer at the given position. | |
| void | transfer (PtrList< tetherPotential > &list) |
| Transfer into this list and annul the argument list. | |
| void | operator= (const UPtrList< tetherPotential > &list) |
| Copy assignment. | |
| void | setSize (const label n) |
| Same as resize(). | |
| void | append (autoPtr< tetherPotential > &ptr) |
| Move append an element to the end of the list. | |
| Public Member Functions inherited from UPtrList< tetherPotential > | |
| bool | empty () const noexcept |
| True if the list is empty (ie, size() is zero). | |
| label | size () const noexcept |
| The number of entries in the list. | |
| label | capacity () const noexcept |
| Size of the underlying storage. | |
| label | count_nonnull () const noexcept |
| The number of non-nullptr entries in the list. | |
| tetherPotential & | front () |
| Reference to the first element of the list. | |
| tetherPotential & | back () |
| Reference to the last element of the list. | |
| const tetherPotential * | test (const label i) const |
| Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). | |
| const tetherPotential * | get (const label i) const |
| Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). | |
| const tetherPotential * | set (const label i) const |
| Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). | |
| void | clear () |
| Set list size to zero. | |
| void | free () |
| Nullify all entries. Does not change the list size. | |
| void | resize (const label newLen) |
Change the size of the list. Any new entries are nullptr. | |
| void | resize_null (const label newLen) |
Set the list to the given size and set all entries to nullptr. | |
| label | squeezeNull () |
| Squeeze out nullptr entries in the list of pointers after which any null pointers will be at the end of the list. | |
| void | push_back (tetherPotential *ptr) |
| Append an element to the end of the list. | |
| void | swap (UPtrList< tetherPotential > &list) noexcept |
| Swap content. | |
| void | transfer (UPtrList< tetherPotential > &list) |
| Transfer contents into this list and annul the argument. | |
| void | reorder (const labelUList &oldToNew, const bool check=false) |
| Reorder elements. Reordering must be unique (ie, shuffle). | |
| void | sortOrder (const labelUList &order, const bool check=false) |
| Reorder elements according to new order mapping (newToOld). Reordering must be unique (ie, shuffle). | |
| void | checkNonNull () const |
| Check and raise FatalError if any nullptr exists in the list. | |
| const tetherPotential & | at (const label i) const |
| Return const reference to the element at given position. FatalError for bounds problem or nullptr. | |
| const tetherPotential & | operator[] (const label i) const |
| Return const reference to the element at given position. FatalError for bounds problem or nullptr. Same as at(). | |
| FOAM_DEPRECATED_FOR (2022-09, "get(), set() or test() methods") const tetherPotential *operator()(const label i) const | |
| Deprecated(2022-09) - same as get(). | |
| void | operator= (const UPtrList< tetherPotential > &list) |
| Copy assignment (shallow copies addresses). | |
| Ostream & | printAddresses (Ostream &os) const |
| Print pointer addresses to Ostream (debugging only). | |
| Ostream & | writeList (Ostream &os, const bool trimNull=false) const |
| Write UPtrList to Ostream, optionally ignoring null entries. | |
| tetherPotential ** | begin_ptr () noexcept |
| Iterator to begin of raw pointers traversal (use with caution). | |
| tetherPotential ** | end_ptr () noexcept |
| Iterator beyond end of raw pointers traversal (use with caution). | |
| iterator | begin () |
| Return iterator to begin traversal of non-nullptr entries. | |
| iterator | end () noexcept |
| Return iterator beyond end of UPtrList traversal. | |
| const_iterator | cbegin () const |
| Return const_iterator to begin traversal of non-nullptr entries. | |
| const_iterator | cend () const noexcept |
| Return const_iterator beyond end of UPtrList traversal. | |
| void | setSize (const label n) |
| Alias for resize(). | |
| tetherPotential & | first () |
| Reference to the first element of the list. | |
| tetherPotential & | last () |
| Return reference to the last element of the list. | |
| void | append (tetherPotential *ptr) |
| Append an element to the end of the list. | |
| label | count () const noexcept |
| The number of non-nullptr entries in the list. | |
Additional Inherited Members | |
| Public Types inherited from UPtrList< tetherPotential > | |
| typedef tetherPotential | value_type |
| Type of values the list contains. | |
| typedef tetherPotential & | reference |
| A non-const reference to the value_type. | |
| typedef const tetherPotential & | const_reference |
| A const reference to the value_type. | |
| Protected Member Functions inherited from PtrList< tetherPotential > | |
| void | readIstream (Istream &is, const INew &inew) |
| Read from Istream using Istream constructor class. | |
| Protected Member Functions inherited from UPtrList< tetherPotential > | |
| void | setAddressableSize (const label n) noexcept |
| Adjust addressable size. | |
| label | find_next (label pos) const |
| The next non-null entry after the specified position. | |
| UPtrList (Detail::PtrListDetail< tetherPotential > &&ptrs) noexcept | |
| Low-level move construct. | |
| Protected Attributes inherited from UPtrList< tetherPotential > | |
| Detail::PtrListDetail< tetherPotential > | ptrs_ |
| The list of pointers. | |
Definition at line 48 of file tetherPotentialList.H.
| tetherPotentialList | ( | ) |
Definition at line 82 of file tetherPotentialList.C.
References PtrList< tetherPotential >::PtrList().
| tetherPotentialList | ( | const List< word > & | siteIdList, |
| const dictionary & | tetherPotentialDict, | ||
| const List< word > & | tetherSiteIdList ) |
Construct from siteIdList and potential dictionaries.
Definition at line 89 of file tetherPotentialList.C.
References buildPotentials(), and PtrList< tetherPotential >::PtrList().
| ~tetherPotentialList | ( | ) |
Destructor.
Definition at line 105 of file tetherPotentialList.C.
| void buildPotentials | ( | const List< word > & | siteIdList, |
| const dictionary & | tetherPotentialDict, | ||
| const List< word > & | tetherSiteIdList ) |
Definition at line 111 of file tetherPotentialList.C.
References setSize(), and UList< T >::size().
Referenced by tetherPotentialList().
| const Foam::tetherPotential & tetherPotentialFunction | ( | const label | a | ) | const |
Definition at line 124 of file tetherPotentialList.C.
| Foam::vector force | ( | const label | a, |
| const vector | rIT ) const |
Definition at line 133 of file tetherPotentialList.C.
| Foam::scalar energy | ( | const label | a, |
| const vector | rIT ) const |
Definition at line 143 of file tetherPotentialList.C.
1.16.1 