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

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, autoPtr< CloudFunctionObject< CloudType > > &ptr)
	Set element to given autoPtr 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, std::unique_ptr< CloudFunctionObject< CloudType > > &&ptr)
	Set element to given unique_ptr 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...

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 (CloudFunctionObject< CloudType > *ptr)
	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 (autoPtr< CloudFunctionObject< CloudType > > &&ptr)
	Move 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 (const refPtr< CloudFunctionObject< CloudType > > &ptr)
	Move or clone append a refPtr 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...

autoPtr< CloudFunctionObject< CloudType > >	emplace (const label i, Args &&... args)
	Construct and set an element. More...

Foam::autoPtr< CloudFunctionObject< CloudType > >	emplace (const label i, Args &&... args)

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

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

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

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

List of cloud function objects.

Source files

Definition at line 54 of file CloudFunctionObjectList.H.

Constructor & Destructor Documentation

◆ CloudFunctionObjectList() [1/3]

CloudFunctionObjectList ( CloudType & owner )

Null constructor.

Definition at line 35 of file CloudFunctionObjectList.C.

◆ CloudFunctionObjectList() [2/3]

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

Construct from mesh.

Definition at line 47 of file CloudFunctionObjectList.C.

References CloudFunctionObjectList< CloudType >::dict(), Foam::endl(), dictionary::get(), Foam::Info, CloudFunctionObjectList< CloudType >::owner(), Foam::readFields(), PtrList< CloudFunctionObject< CloudType > >::resize(), PtrList< CloudFunctionObject< CloudType > >::set(), dictionary::subDict(), and dictionary::toc().

Here is the call graph for this function:

◆ CloudFunctionObjectList() [3/3]

CloudFunctionObjectList ( const CloudFunctionObjectList< CloudType > & ppml )

Construct copy.

Definition at line 94 of file CloudFunctionObjectList.C.

◆ ~CloudFunctionObjectList()

virtual ~CloudFunctionObjectList ( )

virtualdefault

Destructor.

Member Function Documentation

◆ owner() [1/2]

const CloudType & owner

inline

Return const access to the cloud owner.

Definition at line 29 of file CloudFunctionObjectListI.H.

Referenced by CloudFunctionObjectList< CloudType >::CloudFunctionObjectList().

Here is the caller graph for this function:

◆ owner() [2/2]

CloudType & owner

inline

Return reference to the cloud owner.

Definition at line 36 of file CloudFunctionObjectListI.H.

◆ dict()

const Foam::dictionary & dict

inline

Return the forces dictionary.

Definition at line 44 of file CloudFunctionObjectListI.H.

Referenced by CloudFunctionObjectList< CloudType >::CloudFunctionObjectList().

Here is the caller graph for this function:

◆ preEvolve()

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

virtual

Pre-evolve hook.

Definition at line 108 of file CloudFunctionObjectList.C.

References forAll.

◆ postEvolve()

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

virtual

Post-evolve hook.

Definition at line 121 of file CloudFunctionObjectList.C.

References forAll.

◆ postMove()

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

virtual

Post-move hook.

Definition at line 134 of file CloudFunctionObjectList.C.

◆ postPatch()

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

virtual

Post-patch hook.

Definition at line 155 of file CloudFunctionObjectList.C.

References forAll, and p.

◆ postFace()

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

virtual

Post-face hook.

Definition at line 175 of file CloudFunctionObjectList.C.

References forAll, and p.

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

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_