Public Member Functions | Protected Attributes | List of all members
regionModelFunctionObjectList Class Reference

List of cloud function objects. More...

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

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 regionModel & region () const
 Return const access to the cloud region. More...
 
regionModel & region ()
 Return reference to the cloud region. More...
 
const dictionary & dict () 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 >
constexpr PtrList () noexcept
 Default construct. More...
 
 PtrList (const label len)
 Construct with specified size, each element initialized to nullptr. More...
 
 PtrList (const PtrList< regionModelFunctionObject > &list)
 Copy construct using 'clone()' method on each element. More...
 
 PtrList (PtrList< regionModelFunctionObject > &&list)
 Move construct. More...
 
 PtrList (UList< regionModelFunctionObject * > &list)
 Take ownership of pointers in the list, set old pointers to null. More...
 
 PtrList (const PtrList< regionModelFunctionObject > &list, const CloneArg &cloneArgs)
 Copy construct using 'clone()' method on each element. More...
 
 PtrList (PtrList< regionModelFunctionObject > &list, bool reuse)
 Construct as copy or re-use as specified. More...
 
 PtrList (const SLPtrList< regionModelFunctionObject > &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< regionModelFunctionObject > clone (Args &&... args) const
 Make a copy by cloning each of the list elements. More...
 
Foam::PtrList< regionModelFunctionObject > clone (Args &&... args) const
 
const regionModelFunctionObject * set (const label i) const
 Return const pointer to element (can be nullptr),. More...
 
autoPtr< regionModelFunctionObject > set (const label i, regionModelFunctionObject *ptr)
 Set element to given pointer and return old element (can be null) More...
 
autoPtr< regionModelFunctionObject > set (const label i, autoPtr< regionModelFunctionObject > &ptr)
 Set element to given autoPtr and return old element. More...
 
autoPtr< regionModelFunctionObject > set (const label i, autoPtr< regionModelFunctionObject > &&ptr)
 Set element to given autoPtr and return old element. More...
 
autoPtr< regionModelFunctionObject > set (const label i, std::unique_ptr< regionModelFunctionObject > &&ptr)
 Set element to given unique_ptr and return old element. More...
 
autoPtr< regionModelFunctionObject > set (const label i, const refPtr< regionModelFunctionObject > &ptr)
 Set element to given refPtr and return old element. More...
 
autoPtr< regionModelFunctionObject > set (const label i, const tmp< regionModelFunctionObject > &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 (regionModelFunctionObject *ptr)
 Append an element to the end of the list. More...
 
void append (autoPtr< regionModelFunctionObject > &ptr)
 Move append an element to the end of the list. More...
 
void append (autoPtr< regionModelFunctionObject > &&ptr)
 Move append an element to the end of the list. More...
 
void append (std::unique_ptr< regionModelFunctionObject > &&ptr)
 Move append an element to the end of the list. More...
 
void append (const refPtr< regionModelFunctionObject > &ptr)
 Move or clone append a refPtr to the end of the list. More...
 
void append (const tmp< regionModelFunctionObject > &ptr)
 Move or clone append a tmp to the end of the list. More...
 
autoPtr< regionModelFunctionObject > emplace (const label i, Args &&... args)
 Construct and set an element. More...
 
Foam::autoPtr< regionModelFunctionObject > emplace (const label i, Args &&... args)
 
autoPtr< regionModelFunctionObject > release (const label i)
 Release ownership of the pointer at the given position. More...
 
void transfer (PtrList< regionModelFunctionObject > &list)
 Transfer into this list and annul the argument list. More...
 
void operator= (const PtrList< regionModelFunctionObject > &list)
 Copy assignment. More...
 
void operator= (PtrList< regionModelFunctionObject > &&list)
 Move assignment. More...
 

Protected Attributes

regionModel & regionModel_
 Reference to the region region model. More...
 
const dictionary dict_
 Dictionary. More...
 

Additional Inherited Members

- Protected Member Functions inherited from PtrList< regionModelFunctionObject >
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...
 

Detailed Description

List of cloud function objects.

Source files

Definition at line 56 of file regionModelFunctionObjectList.H.

Constructor & Destructor Documentation

◆ regionModelFunctionObjectList() [1/3]

regionModelFunctionObjectList ( regionModel &  region)

Null constructor.

Definition at line 34 of file regionModelFunctionObjectList.C.

◆ regionModelFunctionObjectList() [2/3]

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

Construct from mesh.

Definition at line 45 of file regionModelFunctionObjectList.C.

References dict, Foam::endl(), forAll, Foam::Info, Foam::New(), Foam::readFields(), Foam::BitOps::set(), and setSize().

Here is the call graph for this function:

◆ regionModelFunctionObjectList() [3/3]

regionModelFunctionObjectList ( const regionModelFunctionObjectList &  rmfol)

Construct copy.

Definition at line 90 of file regionModelFunctionObjectList.C.

◆ ~regionModelFunctionObjectList()

~regionModelFunctionObjectList ( )
virtual

Destructor.

Definition at line 103 of file regionModelFunctionObjectList.C.

Member Function Documentation

◆ region() [1/2]

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

Return const access to the cloud region.

Definition at line 29 of file regionModelFunctionObjectListI.H.

References regionModelFunctionObjectList::regionModel_.

◆ region() [2/2]

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

Return reference to the cloud region.

Definition at line 36 of file regionModelFunctionObjectListI.H.

◆ dict()

const Foam::dictionary & dict ( ) const
inline

Return the forces dictionary.

Definition at line 43 of file regionModelFunctionObjectListI.H.

◆ preEvolveRegion()

void preEvolveRegion ( )
virtual

Pre-evolve hook.

Definition at line 109 of file regionModelFunctionObjectList.C.

References forAll.

◆ postEvolveRegion()

void postEvolveRegion ( )
virtual

Post-evolve hook.

Definition at line 118 of file regionModelFunctionObjectList.C.

References forAll.

Member Data Documentation

◆ regionModel_

regionModel& regionModel_
protected

Reference to the region region model.

Definition at line 65 of file regionModelFunctionObjectList.H.

Referenced by regionModelFunctionObjectList::region().

◆ dict_

const dictionary dict_
protected

Dictionary.

Definition at line 68 of file regionModelFunctionObjectList.H.

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