forceList Class Reference

List container for film sources. More...

Inheritance diagram for forceList:
[legend]
Collaboration diagram for forceList:
[legend]

Public Member Functions

 forceList (surfaceFilmRegionModel &film)
 Construct null. More...
 
 forceList (surfaceFilmRegionModel &film, const dictionary &dict)
 Construct from type name, dictionary and surface film model. More...
 
virtual ~forceList ()
 Destructor. More...
 
tmp< fvVectorMatrixcorrect (volVectorField &U)
 Return (net) force system. More...
 
- Public Member Functions inherited from PtrList< force >
constexpr PtrList () noexcept
 Default construct. More...
 
 PtrList (const label len)
 Construct with specified size, each element initialized to nullptr. More...
 
 PtrList (const PtrList< force > &list)
 Copy construct using 'clone()' method on each element. More...
 
 PtrList (PtrList< force > &&list)
 Move construct. More...
 
 PtrList (UList< force * > &list)
 Take ownership of pointers in the list, set old pointers to null. More...
 
 PtrList (const PtrList< force > &list, const CloneArg &cloneArgs)
 Copy construct using 'clone()' method on each element. More...
 
 PtrList (PtrList< force > &list, bool reuse)
 Construct as copy or re-use as specified. More...
 
 PtrList (const SLPtrList< force > &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< force > clone (Args &&... args) const
 Make a copy by cloning each of the list elements. More...
 
Foam::PtrList< force > clone (Args &&... args) const
 
const force * set (const label i) const
 
autoPtr< force > set (const label i, force *ptr)
 Set element to given pointer and return old element (can be null) More...
 
autoPtr< force > set (const label i, autoPtr< force > &ptr)
 Set element to given autoPtr and return old element. More...
 
autoPtr< force > set (const label i, autoPtr< force > &&ptr)
 Set element to given autoPtr and return old element. More...
 
autoPtr< force > set (const label i, std::unique_ptr< force > &&ptr)
 Set element to given unique_ptr and return old element. More...
 
autoPtr< force > set (const label i, const refPtr< force > &ptr)
 Set element to given refPtr and return old element. More...
 
autoPtr< force > set (const label i, const tmp< force > &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 (force *ptr)
 Append an element to the end of the list. More...
 
void append (autoPtr< force > &ptr)
 Move append an element to the end of the list. More...
 
void append (autoPtr< force > &&ptr)
 Move append an element to the end of the list. More...
 
void append (std::unique_ptr< force > &&ptr)
 Move append an element to the end of the list. More...
 
void append (const refPtr< force > &ptr)
 Move or clone append a refPtr to the end of the list. More...
 
void append (const tmp< force > &ptr)
 Move or clone append a tmp to the end of the list. More...
 
void append (PtrList< force > &&other)
 Move append another list to the end of this list. More...
 
autoPtr< force > emplace (const label i, Args &&... args)
 Construct and set an element. More...
 
Foam::autoPtr< force > emplace (const label i, Args &&... args)
 
autoPtr< force > release (const label i)
 Release ownership of the pointer at the given position. More...
 
void transfer (PtrList< force > &list)
 Transfer into this list and annul the argument list. More...
 
void operator= (const PtrList< force > &list)
 Copy assignment. More...
 
void operator= (PtrList< force > &&list)
 Move assignment. More...
 
- Public Member Functions inherited from UPtrList< T >
constexpr UPtrList () noexcept
 Default construct. More...
 
 UPtrList (const label len)
 Construct with specified size, each element initialized to nullptr. More...
 
 UPtrList (const UPtrList< T > &list)
 Copy construct (shallow copies addresses) More...
 
 UPtrList (UPtrList< T > &&list)
 Move construct. More...
 
 UPtrList (UPtrList< T > &list, bool reuse)
 Construct as shallow copy or re-use as specified. More...
 
 UPtrList (PtrList< T > &list)
 Shallow copy from PtrList. More...
 
 UPtrList (const UList< T * > &list)
 Construct from UList of pointers (shallow copy) More...
 
 UPtrList (UList< T > &list)
 Construct from UList, taking the address of each list element. More...
 
label size () const noexcept
 The number of elements in the list. More...
 
bool empty () const noexcept
 True if the list 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...
 
const Ttest (const label i) const
 
Tget (const label i)
 
const Tget (const label i) const
 
const Tset (const label i) const
 
void clear ()
 Set list size to zero. More...
 
void resize (const label newLen)
 Change the size of the list. More...
 
void setSize (const label n)
 Alias for resize() More...
 
label squeezeNull ()
 Squeeze out intermediate nullptr entries in the list of pointers. More...
 
void append (T *ptr)
 Append an element to the end of the list. More...
 
void append (UPtrList< T > &&other)
 Move append another list to the end of this list. More...
 
void swap (UPtrList< T > &list)
 Swap content. More...
 
void transfer (UPtrList< T > &list)
 Transfer contents into this list and annul the argument. More...
 
Tset (const label i, T *ptr)
 
void reorder (const labelUList &oldToNew, const bool check=false)
 
void sortOrder (const labelUList &order, const bool check=false)
 
void checkNonNull () const
 Check and raise FatalError if any nullptr exists in the list. More...
 
const Toperator[] (const label i) const
 Return const reference to the element. More...
 
Toperator[] (const label i)
 Return reference to the element. More...
 
const Toperator() (const label i) const
 Return const pointer to the element - same as get(). More...
 
void operator= (const UPtrList< T > &list)
 Copy assignment (shallow copies addresses) More...
 
void operator= (UPtrList< T > &&list)
 Move assignment. More...
 
T ** begin_ptr () noexcept
 Iterator to begin of raw pointers traversal (use with caution) More...
 
T ** end_ptr () noexcept
 Iterator beyond end of raw pointers traversal (use with caution) More...
 
iterator begin () noexcept
 Return an iterator to begin of UPtrList traversal. More...
 
iterator end () noexcept
 Return iterator beyond end of UPtrList traversal. More...
 
const_iterator cbegin () const noexcept
 Return const_iterator to begin of UPtrList traversal. More...
 
const_iterator cend () const noexcept
 Return const_iterator beyond end of UPtrList traversal. More...
 
const_iterator begin () const noexcept
 Return const_iterator to begin of UPtrList traversal. More...
 
const_iterator end () const noexcept
 Return const_iterator beyond end of UPtrList traversal. More...
 

Additional Inherited Members

- Public Types inherited from UPtrList< T >
typedef T value_type
 Type of values the list contains. More...
 
typedef Treference
 A non-const reference to the value_type. More...
 
typedef const Tconst_reference
 A const reference to the value_type. More...
 
- Protected Member Functions inherited from PtrList< force >
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...
 
- Protected Member Functions inherited from UPtrList< T >
void setAddressableSize (const label n) noexcept
 Adjust addressable size. More...
 
 UPtrList (Detail::PtrListDetail< T > &&ptrs)
 Low-level move construct. More...
 
- Protected Attributes inherited from UPtrList< T >
Detail::PtrListDetail< Tptrs_
 The list of pointers. More...
 

Detailed Description

List container for film sources.

Source files

Source files

Definition at line 55 of file forceList.H.

Constructor & Destructor Documentation

◆ forceList() [1/2]

Construct null.

Definition at line 41 of file forceList.C.

◆ forceList() [2/2]

forceList ( surfaceFilmRegionModel film,
const dictionary dict 
)

Construct from type name, dictionary and surface film model.

Definition at line 47 of file forceList.C.

References dict, Foam::endl(), forAll, Foam::Info, dictionary::lookup(), Time::New(), PtrList< force >::set(), PtrList< force >::setSize(), and UList< T >::size().

Here is the call graph for this function:

◆ ~forceList()

~forceList ( )
virtual

Destructor.

Definition at line 75 of file forceList.C.

Member Function Documentation

◆ correct()

tmp< fvVectorMatrix > correct ( volVectorField U)

Return (net) force system.

Definition at line 80 of file forceList.C.

References Foam::dimArea, Foam::dimForce, Foam::dimVolume, forAll, UPtrList< T >::operator[](), tmp< T >::ref(), and U.

Here is the call graph for this function:

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