Loading...
Searching...
No Matches
forceList Class Reference

#include <forceList.H>

Inheritance diagram for forceList:
Collaboration diagram for forceList:

Public Member Functions

 forceList (liquidFilmBase &film)
 Construct null.
 forceList (liquidFilmBase &film, const dictionary &dict)
 Construct from type name, dictionary and surface film model.
virtual ~forceList ()
 Destructor.
tmp< faVectorMatrixcorrect (areaVectorField &U)
 Return (net) force system.
Public Member Functions inherited from PtrList< force >
Foam::PtrList< force > clone (Args &&... args) const
constexpr PtrList () noexcept
 Default construct.
 ~PtrList ()
 Destructor. Frees all pointers.
const force * 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.
force & 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 (force *ptr)
 Append an element to the end of the list.
force & emplace_set (const label i, Args &&... args)
 Construct and set a new element at given position, (discard old element at that location).
force & emplace (const label i, Args &&... args)
 Same as emplace_set().
force & try_emplace (const label i, Args &&... args)
 Like emplace_set() but will not overwrite an occupied (non-null) location.
autoPtr< force > release (const label i)
 Release ownership of the pointer at the given position.
void transfer (PtrList< force > &list)
 Transfer into this list and annul the argument list.
void operator= (const UPtrList< force > &list)
 Copy assignment.
void setSize (const label n)
 Same as resize().
void append (autoPtr< force > &ptr)
 Move append an element to the end of the list.
Public Member Functions inherited from UPtrList< force >
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.
force & front ()
 Reference to the first element of the list.
force & back ()
 Reference to the last element of the list.
const force * 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 force * 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 force * 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 (force *ptr)
 Append an element to the end of the list.
void swap (UPtrList< force > &list) noexcept
 Swap content.
void transfer (UPtrList< force > &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 force & at (const label i) const
 Return const reference to the element at given position. FatalError for bounds problem or nullptr.
const force & 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 force *operator()(const label i) const
 Deprecated(2022-09) - same as get().
void operator= (const UPtrList< force > &list)
 Copy assignment (shallow copies addresses).
OstreamprintAddresses (Ostream &os) const
 Print pointer addresses to Ostream (debugging only).
OstreamwriteList (Ostream &os, const bool trimNull=false) const
 Write UPtrList to Ostream, optionally ignoring null entries.
force ** begin_ptr () noexcept
 Iterator to begin of raw pointers traversal (use with caution).
force ** 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().
force & first ()
 Reference to the first element of the list.
force & last ()
 Return reference to the last element of the list.
void append (force *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< force >
typedef force value_type
 Type of values the list contains.
typedef force & reference
 A non-const reference to the value_type.
typedef const force & const_reference
 A const reference to the value_type.
Protected Member Functions inherited from PtrList< force >
void readIstream (Istream &is, const INew &inew)
 Read from Istream using Istream constructor class.
Protected Member Functions inherited from UPtrList< force >
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< force > &&ptrs) noexcept
 Low-level move construct.
Protected Attributes inherited from UPtrList< force >
Detail::PtrListDetail< force > ptrs_
 The list of pointers.

Detailed Description

Definition at line 90 of file forceList.H.

Constructor & Destructor Documentation

◆ forceList() [1/2]

forceList ( liquidFilmBase & film)

Construct null.

Definition at line 34 of file forceList.C.

References PtrList< force >::PtrList().

Here is the call graph for this function:

◆ forceList() [2/2]

forceList ( liquidFilmBase & film,
const dictionary & dict )

Construct from type name, dictionary and surface film model.

Definition at line 40 of file forceList.C.

References dict, Foam::endl(), forAll, Foam::Info, force::New(), PtrList< force >::PtrList(), 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 69 of file forceList.C.

Member Function Documentation

◆ correct()

tmp< faVectorMatrix > correct ( areaVectorField & U)

Return (net) force system.

Definition at line 75 of file forceList.C.

References Foam::dimDensity, Foam::dimForce, forAll, tmp< T >::New(), UPtrList< force >::operator[](), and U.

Here is the call graph for this function:

The documentation for this class was generated from the following files:
  • src/regionFaModels/liquidFilm/subModels/kinematic/force/forceList/forceList.H
  • src/regionFaModels/liquidFilm/subModels/kinematic/force/forceList/forceList.C