regionModelFunctionObjectList Class Reference

List of cloud function objects. More...

Inheritance diagram for regionModelFunctionObjectList:
Collaboration diagram for regionModelFunctionObjectList:

Public Member Functions

 regionModelFunctionObjectList (regionModel &region)
 Null constructor. More...
 
 regionModelFunctionObjectList (regionModel &region, const dictionary &dict, const bool readFields=true)
 Construct from mesh. More...
 
 regionModelFunctionObjectList (const regionModelFunctionObjectList &rmfol)
 Construct copy. More...
 
virtual ~regionModelFunctionObjectList ()
 Destructor. More...
 
const regionModelregion () const
 Return const access to the cloud region. More...
 
regionModelregion ()
 Return references to the cloud region. More...
 
const dictionarydict () const
 Return the forces dictionary. More...
 
virtual void preEvolveRegion ()
 Pre-evolve hook. More...
 
virtual void postEvolveRegion ()
 Post-evolve hook. More...
 
- Public Member Functions inherited from PtrList< regionModelFunctionObject >
 PtrList ()
 Null Constructor. More...
 
 PtrList (const label)
 Construct with size specified. More...
 
 PtrList (const PtrList< regionModelFunctionObject > &)
 Copy constructor. More...
 
 PtrList (const PtrList< regionModelFunctionObject > &, const CloneArg &)
 Copy constructor with additional argument for clone. More...
 
 PtrList (PtrList< regionModelFunctionObject > &&)
 Move constructor. More...
 
 PtrList (PtrList< regionModelFunctionObject > &, bool reuse)
 Construct as copy or re-use as specified. More...
 
 PtrList (const SLPtrList< regionModelFunctionObject > &)
 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 (regionModelFunctionObject *)
 Append an element at the end of the list. More...
 
void append (const autoPtr< regionModelFunctionObject > &)
 
void append (const tmp< regionModelFunctionObject > &)
 
void transfer (PtrList< regionModelFunctionObject > &)
 Transfer the contents of the argument PtrList into this PtrList. More...
 
bool set (const label) const
 Is element set. More...
 
autoPtr< regionModelFunctionObject > set (const label, regionModelFunctionObject *)
 Set element to given T* and return old element (can be nullptr) More...
 
autoPtr< regionModelFunctionObject > set (const label, const autoPtr< regionModelFunctionObject > &)
 Set element to given autoPtr<T> and return old element. More...
 
autoPtr< regionModelFunctionObject > set (const label, const tmp< regionModelFunctionObject > &)
 Set element to given tmp<T> and return old element. More...
 
void reorder (const labelUList &oldToNew)
 Reorders elements. Ordering does not have to be done in. More...
 
void shuffle (const labelUList &newToOld)
 Reorders elements. Ordering does not have to be done in. More...
 
void operator= (const PtrList< regionModelFunctionObject > &)
 Assignment operator. More...
 
void operator= (PtrList< regionModelFunctionObject > &&)
 Move assignment operator. More...
 
- Public Member Functions inherited from UPtrList< T >
 UPtrList ()
 Null Constructor. More...
 
 UPtrList (const label)
 Construct with size specified. 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...
 
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 &oldToNew)
 Reorders elements. Ordering does not have to be done in. More...
 
void shuffle (const labelUList &newToOld)
 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...
 

Protected Attributes

regionModelregionModel_
 Reference to the region region model. More...
 
const dictionary dict_
 Dictionary. 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< regionModelFunctionObject >
void read (Istream &, const INew &inewt)
 Read from Istream using given Istream constructor class. More...
 

Detailed Description

Constructor & Destructor Documentation

◆ regionModelFunctionObjectList() [1/3]

Null constructor.

Definition at line 31 of file regionModelFunctionObjectList.C.

Referenced by regionModelFunctionObjectList::regionModelFunctionObjectList().

Here is the caller graph for this function:

◆ regionModelFunctionObjectList() [2/3]

regionModelFunctionObjectList ( regionModel region,
const dictionary dict,
const bool  readFields = true 
)

Construct from mesh.

Definition at line 42 of file regionModelFunctionObjectList.C.

References Foam::endl(), forAll, Foam::Info, Foam::New(), regionModelFunctionObjectList::regionModelFunctionObjectList(), setSize(), and dictionary::toc().

Here is the call graph for this function:

◆ regionModelFunctionObjectList() [3/3]

Construct copy.

Definition at line 87 of file regionModelFunctionObjectList.C.

References regionModelFunctionObjectList::~regionModelFunctionObjectList().

Here is the call graph for this function:

◆ ~regionModelFunctionObjectList()

Destructor.

Definition at line 100 of file regionModelFunctionObjectList.C.

Referenced by regionModelFunctionObjectList::regionModelFunctionObjectList().

Here is the caller graph for this function:

Member Function Documentation

◆ region() [1/2]

const Foam::regionModels::regionModel & region ( ) const
inline

Return const access to the cloud region.

Definition at line 27 of file regionModelFunctionObjectListI.H.

References regionModelFunctionObjectList::regionModel_.

◆ region() [2/2]

Foam::regionModels::regionModel & region ( )
inline

Return references to the cloud region.

Definition at line 34 of file regionModelFunctionObjectListI.H.

References regionModelFunctionObjectList::regionModel_.

◆ dict()

const Foam::dictionary & dict ( ) const
inline

Return the forces dictionary.

Definition at line 41 of file regionModelFunctionObjectListI.H.

References regionModelFunctionObjectList::dict_.

◆ preEvolveRegion()

void preEvolveRegion ( )
virtual

Pre-evolve hook.

Definition at line 106 of file regionModelFunctionObjectList.C.

References forAll, and UPtrList< T >::operator[]().

Here is the call graph for this function:

◆ postEvolveRegion()

void postEvolveRegion ( )
virtual

Post-evolve hook.

Definition at line 115 of file regionModelFunctionObjectList.C.

References forAll, and UPtrList< T >::operator[]().

Here is the call graph for this function:

Member Data Documentation

◆ regionModel_

regionModel& regionModel_
protected

Reference to the region region model.

Definition at line 63 of file regionModelFunctionObjectList.H.

Referenced by regionModelFunctionObjectList::region().

◆ dict_

const dictionary dict_
protected

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