List of cloud function objects. More...

Inheritance diagram for CloudFunctionObjectList< CloudType >:

Collaboration diagram for CloudFunctionObjectList< CloudType >:

Public Member Functions
	CloudFunctionObjectList (CloudType &owner)
	Null constructor. More...

	CloudFunctionObjectList (CloudType &owner, const dictionary &dict, const bool readFields)
	Construct from mesh. More...

	CloudFunctionObjectList (const CloudFunctionObjectList &ppml)
	Construct copy. More...

virtual	~CloudFunctionObjectList ()=default
	Destructor. More...

const CloudType &	owner () const
	Return const access to the cloud owner. More...

CloudType &	owner ()
	Return reference to the cloud owner. More...

const dictionary &	dict () const
	Return the forces dictionary. More...

virtual void	preEvolve (const typename parcelType::trackingData &td)
	Pre-evolve hook. More...

virtual void	postEvolve (const typename parcelType::trackingData &td)
	Post-evolve hook. More...

virtual void	postMove (parcelType &p, const scalar dt, const point &position0, bool &keepParticle)
	Post-move hook. More...

virtual void	postPatch (const parcelType &p, const polyPatch &pp, bool &keepParticle)
	Post-patch hook. More...

virtual void	postFace (const parcelType &p, bool &keepParticle)
	Post-face hook. More...

Public Member Functions inherited from PtrList< CloudFunctionObject< CloudType > >
constexpr	PtrList () noexcept
	Default construct. More...

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

	PtrList (const PtrList< CloudFunctionObject< CloudType > > &list)
	Copy construct using 'clone()' method on each element. More...

	PtrList (PtrList< CloudFunctionObject< CloudType > > &&list)
	Move construct. More...

	PtrList (UList< CloudFunctionObject< CloudType > * > &list)
	Take ownership of pointers in the list, set old pointers to null. More...

	PtrList (const PtrList< CloudFunctionObject< CloudType > > &list, const CloneArg &cloneArgs)
	Copy construct using 'clone()' method on each element. More...

	PtrList (PtrList< CloudFunctionObject< CloudType > > &list, bool reuse)
	Construct as copy or re-use as specified. More...

	PtrList (const SLPtrList< CloudFunctionObject< CloudType > > &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. Frees all pointers. More...

PtrList< CloudFunctionObject< CloudType > >	clone (Args &&... args) const
	Make a copy by cloning each of the list elements. More...

Foam::PtrList< CloudFunctionObject< CloudType > >	clone (Args &&... args) const

const CloudFunctionObject< CloudType > *	set (const label i) const
	Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More...

autoPtr< CloudFunctionObject< CloudType > >	set (const label i, CloudFunctionObject< CloudType > *ptr)
	Set element to given pointer and return old element (can be null) More...

autoPtr< CloudFunctionObject< CloudType > >	set (const label i, std::unique_ptr< CloudFunctionObject< CloudType > > &&ptr)
	Set element to given unique_ptr and return old element. More...

autoPtr< CloudFunctionObject< CloudType > >	set (const label i, autoPtr< CloudFunctionObject< CloudType > > &&ptr)
	Set element to given autoPtr and return old element. More...

autoPtr< CloudFunctionObject< CloudType > >	set (const label i, const refPtr< CloudFunctionObject< CloudType > > &ptr)
	Set element to given refPtr and return old element. More...

autoPtr< CloudFunctionObject< CloudType > >	set (const label i, const tmp< CloudFunctionObject< CloudType > > &ptr)
	Set element to given tmp and return old element. More...

autoPtr< CloudFunctionObject< CloudType > >	set (const label i, autoPtr< CloudFunctionObject< CloudType > > &ptr)
	Set element to given autoPtr and return old element. More...

void	clear ()
	Clear the PtrList. Delete allocated entries and set size to zero. More...

void	free ()
	Free memory and nullify all entries. Does not change the list size. More...

void	resize (const label newLen)
	Adjust size of PtrList. More...

CloudFunctionObject< CloudType > &	emplace_back (Args &&... args)
	Construct and append an element to the end of the list, return reference to the new list element. More...

void	push_back (CloudFunctionObject< CloudType > *ptr)
	Append an element to the end of the list. More...

void	push_back (std::unique_ptr< CloudFunctionObject< CloudType > > &&ptr)
	Move append an element to the end of the list. More...

void	push_back (autoPtr< CloudFunctionObject< CloudType > > &&ptr)
	Move append an element to the end of the list. More...

void	push_back (const refPtr< CloudFunctionObject< CloudType > > &ptr)
	Move or clone append a refPtr to the end of the list. More...

void	push_back (const tmp< CloudFunctionObject< CloudType > > &ptr)
	Move or clone append a tmp to the end of the list. More...

void	push_back (PtrList< CloudFunctionObject< CloudType > > &&other)
	Move append another list to the end of this list. More...

void	push_back (autoPtr< CloudFunctionObject< CloudType > > &ptr)=delete
	Disallow push_back with autoPtr without std::move. More...

CloudFunctionObject< CloudType > &	emplace_set (const label i, Args &&... args)
	Construct and set a new element at given position, (discard old element at that location). Return reference to the new list element. More...

CloudFunctionObject< CloudType > &	emplace (const label i, Args &&... args)
	Same as emplace_set() More...

autoPtr< CloudFunctionObject< CloudType > >	release (const label i)
	Release ownership of the pointer at the given position. More...

void	transfer (PtrList< CloudFunctionObject< CloudType > > &list)
	Transfer into this list and annul the argument list. More...

void	operator= (const PtrList< CloudFunctionObject< CloudType > > &list)
	Copy assignment. More...

void	operator= (PtrList< CloudFunctionObject< CloudType > > &&list)
	Move assignment. More...

void	setSize (const label newLen)
	Same as resize() More...

void	append (autoPtr< CloudFunctionObject< CloudType > > &ptr)
	Move append an element to the end of the list. More...

void	append (CloudFunctionObject< CloudType > *ptr)
	Append an element to the end of the list. More...

void	append (std::unique_ptr< CloudFunctionObject< CloudType > > &&ptr)
	Move append an element to the end of the list. More...

void	append (autoPtr< CloudFunctionObject< CloudType > > &&ptr)
	Move append an element to the end of the list. More...

void	append (const refPtr< CloudFunctionObject< CloudType > > &ptr)
	Move or clone append a tmp to the end of the list. More...

void	append (const tmp< CloudFunctionObject< CloudType > > &ptr)
	Move or clone append a tmp to the end of the list. More...

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

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

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

label	count () const noexcept
	The number of non-null entries in the list. More...

T &	front ()
	Reference to the first element of the list. More...

const T &	front () const
	Reference to first element of the list. More...

T &	back ()
	Reference to the last element of the list. More...

const T &	back () const
	Reference to the last element of the list. More...

const T *	test (const label i) const
	Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More...

const T *	get (const label i) const
	Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More...

T *	get (const label i)
	Return pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More...

const T *	set (const label i) const
	Return const pointer to element (can be nullptr), or nullptr for out-of-range access (ie, with bounds checking). More...

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

void	free ()
	Nullify all entries. Does not change the list size. More...

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

label	squeezeNull ()
	Squeeze out nullptr entries in the list of pointers after which any null pointers will be at the end of the list. More...

void	trimTrailingNull ()
	Reduce addressable list size to ignore any trailing null pointers. More...

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

void	push_back (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)
	Set element to specified pointer and return the old list element, which can be a nullptr. More...

void	reorder (const labelUList &oldToNew, const bool check=false)
	Reorder elements. Reordering must be unique (ie, shuffle). More...

void	sortOrder (const labelUList &order, const bool check=false)
	Reorder elements according to new order mapping (newToOld). Reordering must be unique (ie, shuffle). More...

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

const T &	at (const label i) const
	Return const reference to the element at given position. FatalError for bounds problem or nullptr. More...

T &	at (const label i)
	Return reference to the element at given position. FatalError for bounds problem or nullptr. More...

const T &	operator[] (const label i) const
	Return const reference to the element at given position. FatalError for bounds problem or nullptr. Same as at(). More...

T &	operator[] (const label i)
	Return reference to the element at given position. FatalError for bounds problem or nullptr. Same as at(). More...

	FOAM_DEPRECATED_FOR (2022-09, "get(), set() or test() methods") const T *operator()(const label i) const
	Deprecated(2022-09) - 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 ()
	Return iterator to begin traversal of non-nullptr entries. More...

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

const_iterator	cbegin () const
	Return const_iterator to begin traversal of non-nullptr entries. More...

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

const_iterator	begin () const
	Return const_iterator to begin traversal of non-nullptr entries. More...

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

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

T &	first ()
	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...

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

Protected Attributes
const CloudType &	owner_
	Reference to the owner cloud. 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< CloudFunctionObject< CloudType > >
void	readIstream (Istream &is, const INew &inew)
	Read from Istream using Istream constructor class. More...

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

label	find_next (label pos) const
	The next non-null entry after the specified position. More...

	UPtrList (Detail::PtrListDetail< T > &&ptrs)
	Low-level move construct. More...

Detailed Description

template<class CloudType>
class Foam::CloudFunctionObjectList< CloudType >

List of cloud function objects.

Source files

Definition at line 50 of file CloudFunctionObjectList.H.

Constructor & Destructor Documentation

◆ CloudFunctionObjectList() [1/3]

CloudFunctionObjectList ( CloudType & owner )

Null constructor.

Definition at line 29 of file CloudFunctionObjectList.C.

◆ CloudFunctionObjectList() [2/3]

CloudFunctionObjectList	(	CloudType &	owner,
		const dictionary &	dict,
		const bool	readFields
	)

Construct from mesh.

Definition at line 41 of file CloudFunctionObjectList.C.

◆ CloudFunctionObjectList() [3/3]

CloudFunctionObjectList ( const CloudFunctionObjectList< CloudType > & ppml )

Construct copy.

Definition at line 88 of file CloudFunctionObjectList.C.

◆ ~CloudFunctionObjectList()

virtual ~CloudFunctionObjectList ( )

virtualdefault

Destructor.

Member Function Documentation

◆ owner() [1/2]

const CloudType & owner ( ) const

inline

Return const access to the cloud owner.

Definition at line 22 of file CloudFunctionObjectListI.H.

◆ owner() [2/2]

CloudType & owner ( )

inline

Return reference to the cloud owner.

Definition at line 29 of file CloudFunctionObjectListI.H.

◆ dict()

const Foam::dictionary & dict ( ) const

inline

Return the forces dictionary.

Definition at line 37 of file CloudFunctionObjectListI.H.

◆ preEvolve()

void preEvolve ( const typename parcelType::trackingData & td )

virtual

Pre-evolve hook.

Definition at line 102 of file CloudFunctionObjectList.C.

◆ postEvolve()

void postEvolve ( const typename parcelType::trackingData & td )

virtual

Post-evolve hook.

Definition at line 115 of file CloudFunctionObjectList.C.

◆ postMove()

void postMove	(	parcelType &	p,
		const scalar	dt,
		const point &	position0,
		bool &	keepParticle
	)

virtual

Post-move hook.

Definition at line 128 of file CloudFunctionObjectList.C.

◆ postPatch()

void postPatch	(	const parcelType &	p,
		const polyPatch &	pp,
		bool &	keepParticle
	)

virtual

Post-patch hook.

Definition at line 149 of file CloudFunctionObjectList.C.

◆ postFace()

void postFace	(	const parcelType &	p,
		bool &	keepParticle
	)

virtual

Post-face hook.

Definition at line 169 of file CloudFunctionObjectList.C.

Member Data Documentation

◆ owner_

const CloudType& owner_

protected

Reference to the owner cloud.

Definition at line 69 of file CloudFunctionObjectList.H.

◆ dict_

const dictionary dict_

protected

Dictionary.

Definition at line 74 of file CloudFunctionObjectList.H.

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

src/lagrangian/intermediate/submodels/CloudFunctionObjects/CloudFunctionObjectList/CloudFunctionObjectList.H
src/lagrangian/intermediate/submodels/CloudFunctionObjects/CloudFunctionObjectList/CloudFunctionObjectList.C
src/lagrangian/intermediate/submodels/CloudFunctionObjects/CloudFunctionObjectList/CloudFunctionObjectListI.H

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class CloudType> class Foam::CloudFunctionObjectList< CloudType >

Constructor & Destructor Documentation

◆ CloudFunctionObjectList() [1/3]

◆ CloudFunctionObjectList() [2/3]

◆ CloudFunctionObjectList() [3/3]

◆ ~CloudFunctionObjectList()

Member Function Documentation

◆ owner() [1/2]

◆ owner() [2/2]

◆ dict()

◆ preEvolve()

◆ postEvolve()

◆ postMove()

◆ postPatch()

◆ postFace()

Member Data Documentation

◆ owner_

◆ dict_

template<class CloudType>
class Foam::CloudFunctionObjectList< CloudType >