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 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

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...

void	append (PtrList< regionModelFunctionObject > &&other)
	Move append another list to the end of this 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...

Public Member Functions inherited from UPtrList< T >
constexpr	UPtrList () noexcept
	Default construct. More...

	UPtrList (const label len)
	Construct with specified size, each element initialized to nullptr. More...

	UPtrList (const UPtrList< T > &list)
	Copy construct (shallow copies addresses) More...

	UPtrList (UPtrList< T > &&list)
	Move construct. More...

	UPtrList (UPtrList< T > &list, bool reuse)
	Construct as shallow copy or re-use as specified. More...

	UPtrList (PtrList< T > &list)
	Shallow copy from PtrList. More...

	UPtrList (const UList< T * > &list)
	Construct from UList of pointers (shallow copy) More...

	UPtrList (UList< T > &list)
	Construct from UList, taking the address of each list element. More...

label	size () const noexcept
	The number of elements in the list. More...

bool	empty () const noexcept
	True if the list is empty (ie, size() is zero) More...

T &	first ()
	Return reference to the first element of the list. More...

const T &	first () const
	Return reference to first element of the list. More...

T &	last ()
	Return reference to the last element of the list. More...

const T &	last () const
	Return reference to the last element of the list. More...

const T *	test (const label i) const

T *	get (const label i)

const T *	get (const label i) const

const T *	set (const label i) const

void	clear ()
	Set list size to zero. More...

void	resize (const label newLen)
	Change the size of the list. More...

void	setSize (const label n)
	Alias for resize() More...

label	squeezeNull ()
	Squeeze out intermediate nullptr entries in the list of pointers. More...

void	append (T *ptr)
	Append an element to the end of the list. More...

void	append (UPtrList< T > &&other)
	Move append another list to the end of this list. More...

void	swap (UPtrList< T > &list)
	Swap content. More...

void	transfer (UPtrList< T > &list)
	Transfer contents into this list and annul the argument. More...

T *	set (const label i, T *ptr)

void	reorder (const labelUList &oldToNew, const bool check=false)

void	sortOrder (const labelUList &order, const bool check=false)

void	checkNonNull () const
	Check and raise FatalError if any nullptr exists in the list. More...

const T &	operator[] (const label i) const
	Return const reference to the element. More...

T &	operator[] (const label i)
	Return reference to the element. More...

const T *	operator() (const label i) const
	Return const pointer to the element - same as get(). More...

void	operator= (const UPtrList< T > &list)
	Copy assignment (shallow copies addresses) More...

void	operator= (UPtrList< T > &&list)
	Move assignment. More...

T **	begin_ptr () noexcept
	Iterator to begin of raw pointers traversal (use with caution) More...

T **	end_ptr () noexcept
	Iterator beyond end of raw pointers traversal (use with caution) More...

iterator	begin () noexcept
	Return an iterator to begin of UPtrList traversal. More...

iterator	end () noexcept
	Return iterator beyond end of UPtrList traversal. More...

const_iterator	cbegin () const noexcept
	Return const_iterator to begin of UPtrList traversal. More...

const_iterator	cend () const noexcept
	Return const_iterator beyond end of UPtrList traversal. More...

const_iterator	begin () const noexcept
	Return const_iterator to begin of UPtrList traversal. More...

const_iterator	end () const noexcept
	Return const_iterator beyond end of UPtrList traversal. More...

Protected Attributes
regionModel &	regionModel_
	Reference to the region region model. More...

const dictionary	dict_
	Dictionary. More...

Protected Attributes inherited from UPtrList< T >
Detail::PtrListDetail< T >	ptrs_
	The list of pointers. More...

Additional Inherited Members
Public Types inherited from UPtrList< T >
typedef T	value_type
	Type of values the list contains. More...

typedef T &	reference
	A non-const reference to the value_type. More...

typedef const T &	const_reference
	A const reference to the value_type. More...

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...

Protected Member Functions inherited from UPtrList< T >
void	setAddressableSize (const label n) noexcept
	Adjust addressable size. More...

	UPtrList (Detail::PtrListDetail< T > &&ptrs)
	Low-level move construct. 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 33 of file regionModelFunctionObjectList.C.

◆ regionModelFunctionObjectList() [2/3]

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

Construct from mesh.

Definition at line 44 of file regionModelFunctionObjectList.C.

References regionModelFunctionObjectList::dict(), Foam::endl(), forAll, Foam::Info, Time::New(), Foam::readFields(), regionModelFunctionObjectList::region(), PtrList< regionModelFunctionObject >::set(), PtrList< regionModelFunctionObject >::setSize(), UList< T >::size(), and dictionary::toc().

Here is the call graph for this function:

◆ regionModelFunctionObjectList() [3/3]

regionModelFunctionObjectList ( const regionModelFunctionObjectList & rmfol )

Construct copy.

Definition at line 89 of file regionModelFunctionObjectList.C.

◆ ~regionModelFunctionObjectList()

~regionModelFunctionObjectList ( )

virtual

Destructor.

Definition at line 102 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_.

Referenced by regionModelFunctionObjectList::regionModelFunctionObjectList().

Here is the caller graph for this function:

◆ 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.

Referenced by regionModelFunctionObjectList::regionModelFunctionObjectList().

Here is the caller graph for this function:

◆ 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:

src/regionModels/regionModel/regionModelFunctionObject/regionModelFunctionObject/regionModelFunctionObjectList.H
src/regionModels/regionModel/regionModelFunctionObject/regionModelFunctionObject/regionModelFunctionObjectList.C
src/regionModels/regionModel/regionModelFunctionObject/regionModelFunctionObject/regionModelFunctionObjectListI.H

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ regionModelFunctionObjectList() [1/3]

◆ regionModelFunctionObjectList() [2/3]

◆ regionModelFunctionObjectList() [3/3]

◆ ~regionModelFunctionObjectList()

Member Function Documentation

◆ region() [1/2]

◆ region() [2/2]

◆ dict()

◆ preEvolveRegion()

◆ postEvolveRegion()

Member Data Documentation

◆ regionModel_

◆ dict_