Public Member Functions | Protected Attributes
regionModelFunctionObjectList Class Reference
Inheritance diagram for regionModelFunctionObjectList:
Inheritance graph
[legend]
Collaboration diagram for regionModelFunctionObjectList:
Collaboration graph
[legend]

Public Member Functions

 regionModelFunctionObjectList (regionModel &owner)
 Null constructor. More...
 
 regionModelFunctionObjectList (regionModel &owner, const dictionary &dict, const bool readFields=true)
 Construct from mesh. More...
 
 regionModelFunctionObjectList (const regionModelFunctionObjectList &rmfol)
 Construct copy. More...
 
virtual ~regionModelFunctionObjectList ()
 Destructor. More...
 
const regionModelowner () const
 Return const access to the cloud owner. More...
 
regionModelowner ()
 Return refernce to the cloud owner. 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< T > &)
 Copy constructor. More...
 
 PtrList (const PtrList< T > &, const CloneArg &)
 Copy constructor with additional argument for clone. More...
 
 PtrList (const Xfer< PtrList< T > > &)
 Construct by transferring the parameter contents. More...
 
 PtrList (PtrList< T > &, bool reUse)
 Construct as copy or re-use as specified. More...
 
 PtrList (const SLPtrList< T > &)
 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 ()
 
 PtrList (const label s)
 
 PtrList (const PtrList< T > &a)
 
 PtrList (const Xfer< PtrList< T > > &lst)
 
 PtrList (PtrList< T > &a, bool reUse)
 
 PtrList (const SLPtrList< T > &sll)
 
 PtrList (Istream &is)
 
 ~PtrList ()
 Destructor. More...
 
label size () const
 Return the number of elements in the PtrList. More...
 
bool empty () const
 Return true if the PtrList 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 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 (T *)
 Append an element at the end of the list. More...
 
void append (const autoPtr< T > &)
 
void append (const tmp< T > &)
 
void transfer (PtrList< T > &)
 Transfer the contents of the argument PtrList into this PtrList. More...
 
Xfer< PtrList< T > > xfer ()
 Transfer contents to the Xfer container. More...
 
bool set (const label) const
 Is element set. More...
 
autoPtr< Tset (const label, T *)
 Set element. Return old element (can be NULL). More...
 
autoPtr< Tset (const label, const autoPtr< T > &)
 
autoPtr< Tset (const label, const tmp< T > &)
 
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...
 
PtrList< T > & operator= (const PtrList< T > &)
 Assignment. More...
 
iterator begin ()
 Return an iterator to begin traversing the PtrList. More...
 
const_iterator begin () const
 Return an const_iterator to begin traversing the PtrList. More...
 
iterator end ()
 Return an iterator to end traversing the PtrList. More...
 
const_iterator end () const
 Return an const_iterator to end traversing the PtrList. More...
 
const_iterator cbegin () const
 Return an const_iterator to begin traversing the PtrList. More...
 
const_iterator cend () const
 Return an const_iterator to end traversing the PtrList. More...
 

Protected Attributes

regionModelowner_
 Reference to the owner region model. More...
 
const dictionary dict_
 Dictionary. More...
 

Additional Inherited Members

- Public Types inherited from PtrList< regionModelFunctionObject >
typedef T value_type
 Type of values the PtrList contains. More...
 
typedef Treference
 Type that can be used for storing into PtrList::value_type objects. More...
 
- Data Fields inherited from PtrList< regionModelFunctionObject >
const typedef Tconst_reference
 Type that can be used for storing into constant PtrList::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

Definition at line 54 of file regionModelFunctionObjectList.H.

Constructor & Destructor Documentation

◆ regionModelFunctionObjectList() [1/3]

Null constructor.

Definition at line 31 of file regionModelFunctionObjectList.C.

◆ regionModelFunctionObjectList() [2/3]

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

Construct from mesh.

Definition at line 42 of file regionModelFunctionObjectList.C.

References dict, Foam::endl(), forAll, Foam::Info, Foam::compressible::New(), setSize(), and List::size().

Here is the call graph for this function:

◆ regionModelFunctionObjectList() [3/3]

Construct copy.

Definition at line 87 of file regionModelFunctionObjectList.C.

◆ ~regionModelFunctionObjectList()

Destructor.

Definition at line 100 of file regionModelFunctionObjectList.C.

Member Function Documentation

◆ owner() [1/2]

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

Return const access to the cloud owner.

Definition at line 27 of file regionModelFunctionObjectListI.H.

References regionModelFunctionObjectList::owner_.

◆ owner() [2/2]

regionModel& owner ( )
inline

Return refernce to the cloud owner.

◆ dict()

const Foam::dictionary & dict ( ) const
inline

Return the forces dictionary.

Definition at line 41 of file regionModelFunctionObjectListI.H.

◆ preEvolveRegion()

void preEvolveRegion ( )
virtual

Pre-evolve hook.

Definition at line 106 of file regionModelFunctionObjectList.C.

References forAll.

◆ postEvolveRegion()

void postEvolveRegion ( )
virtual

Post-evolve hook.

Definition at line 115 of file regionModelFunctionObjectList.C.

References forAll.

Field Documentation

◆ owner_

regionModel& owner_
protected

Reference to the owner region model.

Definition at line 63 of file regionModelFunctionObjectList.H.

Referenced by regionModelFunctionObjectList::owner().

◆ dict_

const dictionary dict_
protected

Dictionary.

Definition at line 66 of file regionModelFunctionObjectList.H.


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