List of cloud function objects. More...

Inheritance diagram for CloudFunctionObjectList< CloudType >:

[legend]

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 ()
	Destructor. More...

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

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

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

virtual void	preEvolve ()
	Pre-evolve hook. More...

virtual void	postEvolve ()
	Post-evolve hook. More...

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

virtual void	postPatch (const typename CloudType::parcelType &p, const polyPatch &pp, const scalar trackFraction, const tetIndices &tetIs, bool &keepParticle)
	Post-patch hook. More...

virtual void	postFace (const typename CloudType::parcelType &p, const label facei, bool &keepParticle)
	Post-face hook. More...

Public Member Functions inherited from PtrList< CloudFunctionObject< CloudType > >
	PtrList ()
	Null Constructor. More...

	PtrList (const label)
	Construct with size specified. More...

	PtrList (const PtrList< CloudFunctionObject< CloudType > > &)
	Copy constructor. More...

	PtrList (const PtrList< CloudFunctionObject< CloudType > > &, const CloneArg &)
	Copy constructor with additional argument for clone. More...

	PtrList (const Xfer< PtrList< CloudFunctionObject< CloudType > >> &)
	Construct by transferring the parameter contents. More...

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

	PtrList (const SLPtrList< CloudFunctionObject< CloudType > > &)
	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 ()
	Destructor. 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 (CloudFunctionObject< CloudType > *)
	Append an element at the end of the list. More...

void	append (const autoPtr< CloudFunctionObject< CloudType > > &)

void	append (const tmp< CloudFunctionObject< CloudType > > &)

void	transfer (PtrList< CloudFunctionObject< CloudType > > &)
	Transfer the contents of the argument PtrList into this PtrList. More...

Xfer< PtrList< CloudFunctionObject< CloudType > > >	xfer ()
	Transfer contents to the Xfer container. More...

bool	set (const label) const
	Is element set. More...

autoPtr< CloudFunctionObject< CloudType > >	set (const label, CloudFunctionObject< CloudType > *)
	Set element to given T* and return old element (can be nullptr) More...

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

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

void	reorder (const labelUList &)
	Reorders elements. Ordering does not have to be done in. More...

void	operator= (const PtrList< CloudFunctionObject< CloudType > > &)
	Assignment. More...

Public Member Functions inherited from UPtrList< T >
	UPtrList ()
	Null Constructor. More...

	UPtrList (const label)
	Construct with size specified. More...

	UPtrList (const Xfer< UPtrList< T >> &)
	Construct by transferring the parameter contents. More...

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

label	size () const
	Return the number of elements in the UPtrList. More...

bool	empty () const
	Return true if the UPtrList 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...

void	setSize (const label)
	Reset size of UPtrList. This can only be used to set the size. More...

void	resize (const label)
	Reset size of UPtrList. This can only be used to set the size. More...

void	clear ()
	Clear the UPtrList, i.e. set size to zero. More...

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

Xfer< UPtrList< T > >	xfer ()
	Transfer contents to the Xfer container. More...

bool	set (const label) const
	Is element set. More...

T *	set (const label, T *)
	Set element. Return old element (can be nullptr). More...

void	reorder (const labelUList &)
	Reorders elements. Ordering does not have to be done in. More...

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

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

const T *	operator() (const label) const
	Return element const pointer. More...

iterator	begin ()
	Return an iterator to begin traversing the UPtrList. More...

iterator	end ()
	Return an iterator to end traversing the UPtrList. More...

const_iterator	cbegin () const
	Return an const_iterator to begin traversing the UPtrList. More...

const_iterator	cend () const
	Return an const_iterator to end traversing the UPtrList. More...

const_iterator	begin () const
	Return an const_iterator to begin traversing the UPtrList. More...

const_iterator	end () const
	Return an const_iterator to end traversing the UPtrList. More...

Protected Attributes
const CloudType &	owner_
	Reference to the owner cloud. More...

const dictionary	dict_
	Dictionary. More...

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

typedef T &	reference
	Type that can be used for storing into UPtrList::value_type objects. More...

typedef const T &	const_reference
	Type that can be used for storing into constant UPtrList::value_type. More...

Protected Member Functions inherited from PtrList< CloudFunctionObject< CloudType > >
void	read (Istream &, const INew &inewt)
	Read from Istream using given Istream constructor class. More...

Detailed Description

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

List of cloud function objects.

Source files

Definition at line 51 of file CloudFunctionObjectList.H.

Constructor & Destructor Documentation

◆ CloudFunctionObjectList() [1/3]

CloudFunctionObjectList ( CloudType & owner )

Null constructor.

Definition at line 33 of file CloudFunctionObjectList.C.

Referenced by CloudFunctionObjectList< KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::CloudFunctionObjectList().

Here is the caller graph for this function:

◆ CloudFunctionObjectList() [2/3]

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

Construct from mesh.

Definition at line 45 of file CloudFunctionObjectList.C.

◆ CloudFunctionObjectList() [3/3]

CloudFunctionObjectList ( const CloudFunctionObjectList< CloudType > & ppml )

Construct copy.

Definition at line 97 of file CloudFunctionObjectList.C.

◆ ~CloudFunctionObjectList()

~CloudFunctionObjectList ( )

virtual

Destructor.

Definition at line 110 of file CloudFunctionObjectList.C.

Member Function Documentation

◆ owner() [1/2]

const CloudType & owner ( ) const

inline

Return const access to the cloud owner.

Definition at line 27 of file CloudFunctionObjectListI.H.

◆ owner() [2/2]

CloudType & owner ( )

inline

Return refernce to the cloud owner.

Definition at line 34 of file CloudFunctionObjectListI.H.

◆ dict()

const Foam::dictionary & dict ( ) const

inline

Return the forces dictionary.

Definition at line 42 of file CloudFunctionObjectListI.H.

◆ preEvolve()

void preEvolve ( )

virtual

Pre-evolve hook.

Definition at line 117 of file CloudFunctionObjectList.C.

◆ postEvolve()

void postEvolve ( )

virtual

Post-evolve hook.

Definition at line 127 of file CloudFunctionObjectList.C.

◆ postMove()

void postMove	(	typename CloudType::parcelType &	p,
		const label	celli,
		const scalar	dt,
		const point &	position0,
		bool &	keepParticle
	)

virtual

Post-move hook.

Definition at line 138 of file CloudFunctionObjectList.C.

Referenced by CloudFunctionObjectList< KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::postEvolve().

Here is the caller graph for this function:

◆ postPatch()

void postPatch	(	const typename CloudType::parcelType &	p,
		const polyPatch &	pp,
		const scalar	trackFraction,
		const tetIndices &	tetIs,
		bool &	keepParticle
	)

virtual

Post-patch hook.

Definition at line 160 of file CloudFunctionObjectList.C.

Referenced by CloudFunctionObjectList< KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::postMove().

Here is the caller graph for this function:

◆ postFace()

void postFace	(	const typename CloudType::parcelType &	p,
		const label	facei,
		bool &	keepParticle
	)

virtual

Post-face hook.

Definition at line 189 of file CloudFunctionObjectList.C.

Referenced by CloudFunctionObjectList< KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::postPatch().

Here is the caller graph for this function:

Member Data Documentation

◆ owner_

const CloudType& owner_

protected

Reference to the owner cloud.

Definition at line 60 of file CloudFunctionObjectList.H.

◆ dict_

const dictionary dict_

protected

Dictionary.

Definition at line 63 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 >