Public Member Functions | List of all members
forceList Class Reference

List container for film sources. More...

Inheritance diagram for forceList:
Inheritance graph
[legend]
Collaboration diagram for forceList:
Collaboration graph
[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 >
 PtrList ()
 Null Constructor. More...
 
 PtrList (const label)
 Construct with size specified. More...
 
 PtrList (const PtrList< force > &)
 Copy constructor. More...
 
 PtrList (const PtrList< force > &, const CloneArg &)
 Copy constructor with additional argument for clone. More...
 
 PtrList (const Xfer< PtrList< force >> &)
 Construct by transferring the parameter contents. More...
 
 PtrList (PtrList< force > &, bool reuse)
 Construct as copy or re-use as specified. More...
 
 PtrList (const SLPtrList< force > &)
 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 (force *)
 Append an element at the end of the list. More...
 
void append (const autoPtr< force > &)
 
void append (const tmp< force > &)
 
void transfer (PtrList< force > &)
 Transfer the contents of the argument PtrList into this PtrList. More...
 
Xfer< PtrList< force > > xfer ()
 Transfer contents to the Xfer container. More...
 
bool set (const label) const
 Is element set. More...
 
autoPtr< force > set (const label, force *)
 Set element to given T* and return old element (can be nullptr) More...
 
autoPtr< force > set (const label, const autoPtr< force > &)
 Set element to given autoPtr<T> and return old element. More...
 
autoPtr< force > set (const label, const tmp< force > &)
 Set element to given tmp<T> and return old element. More...
 
void reorder (const labelUList &)
 Reorders elements. Ordering does not have to be done in. More...
 
void operator= (const PtrList< force > &)
 Assignment. More...
 
- Public Member Functions inherited from UPtrList< T >
 UPtrList ()
 Null Constructor. More...
 
 UPtrList (const label)
 Construct with size specified. More...
 
 UPtrList (const Xfer< UPtrList< T >> &)
 Construct by transferring the parameter contents. 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...
 
Xfer< UPtrList< T > > xfer ()
 Transfer contents to the Xfer container. 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 &)
 Reorders elements. Ordering does not have to be done in. 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...
 

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< force >
void read (Istream &, const INew &inewt)
 Read from Istream using given Istream constructor class. More...
 

Detailed Description

List container for film sources.

Source files

Definition at line 53 of file forceList.H.

Constructor & Destructor Documentation

◆ forceList() [1/2]

Construct null.

Definition at line 39 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 46 of file forceList.C.

References Foam::endl(), forAll, Foam::Info, dictionary::lookup(), force::New(), and PtrList< force >::setSize().

Here is the call graph for this function:

◆ ~forceList()

~forceList ( )
virtual

Destructor.

Definition at line 73 of file forceList.C.

Member Function Documentation

◆ correct()

tmp< fvVectorMatrix > correct ( volVectorField U)

Return (net) force system.

Definition at line 78 of file forceList.C.

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

Referenced by kinematicSingleLayer::solveMomentum().

Here is the call graph for this function:
Here is the caller graph for this function:

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