List of references to the cloud function objects. Designed to be constructed temporarily for the scope of cloud evolution so that cloud-specific hooks can be used. More...

Inheritance diagram for cloudFunctionObjectUList:

[legend]

Collaboration diagram for cloudFunctionObjectUList:

[legend]

Public Member Functions
	TypeName ("cloudFunctionObjectUList")
	Runtime type information. More...

	cloudFunctionObjectUList (const cloud &, const bool inner=false)
	Construct from a cloud. More...

	cloudFunctionObjectUList (const cloudFunctionObjectUList &)=delete
	Disallow default bitwise copy construction. More...

virtual	~cloudFunctionObjectUList ()
	Destructor. More...

virtual void	calculate (const LagrangianSubScalarField &deltaT, const bool final)
	Solve equations and/or update continually changing properties. More...

virtual void	preCrossFaces (const LagrangianScalarInternalDynamicField &fraction)
	Hook before face crossings. More...

virtual void	preCrossFaces (const LagrangianSubScalarSubField &fraction)
	Hook before face crossings of a specific sub-mesh. More...

virtual void	postCrossFaces (const LagrangianSubScalarSubField &fraction)
	Hook following face crossings of a specific sub-mesh. More...

virtual void	postCrossFaces (const LagrangianScalarInternalDynamicField &fraction)
	Hook after face crossings. More...

void	operator= (const cloudFunctionObjectUList &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from UPtrList< functionObjects::cloudFunctionObject >
	UPtrList ()
	Null Constructor. More...

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

	UPtrList (UPtrList< functionObjects::cloudFunctionObject > &, bool reuse)
	Construct as copy or reuse as specified. More...

	UPtrList (std::initializer_list< functionObjects::cloudFunctionObject * >)
	Construct from an initialiser list of pointers. 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...

functionObjects::cloudFunctionObject &	first ()
	Return reference to the first element of the list. More...

const functionObjects::cloudFunctionObject &	first () const
	Return reference to first element of the list. More...

functionObjects::cloudFunctionObject &	last ()
	Return reference to the last element of the list. More...

const functionObjects::cloudFunctionObject &	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	append (functionObjects::cloudFunctionObject *)
	Append an element at the end of the list. More...

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

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

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

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

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

UPtrList< T2 >	convert ()
	Convert to list of different pointer type. More...

UPtrList< const T2 >	convert () const
	Convert to list of different pointer type. More...

Foam::UPtrList< T2 >	convert ()

Foam::UPtrList< const T2 >	convert () const

const functionObjects::cloudFunctionObject &	operator[] (const label) const
	Return element const reference. More...

functionObjects::cloudFunctionObject &	operator[] (const label)
	Return element reference. More...

const functionObjects::cloudFunctionObject *	operator() (const label) const
	Return element const pointer. More...

functionObjects::cloudFunctionObject *	operator() (const label)
	Return element const pointer. More...

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

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

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

const_iterator	end () const
	Return an const_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...

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

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

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

Detailed Description

List of references to the cloud function objects. Designed to be constructed temporarily for the scope of cloud evolution so that cloud-specific hooks can be used.

Source files

Definition at line 50 of file cloudFunctionObjectUList.H.

Constructor & Destructor Documentation

◆ cloudFunctionObjectUList() [1/2]

cloudFunctionObjectUList	(	const cloud &	c,
		const bool	inner = `false`
	)

Construct from a cloud.

Definition at line 40 of file cloudFunctionObjectUList.C.

References Foam::constant::universal::c, cloudFunctionObject::cloud(), forAll, UPtrList< functionObjects::cloudFunctionObject >::operator[](), cloudFunctionObject::preSolve(), UPtrList< T >::resize(), and UPtrList< T >::set().

Here is the call graph for this function:

◆ cloudFunctionObjectUList() [2/2]

cloudFunctionObjectUList ( const cloudFunctionObjectUList & )

delete

Disallow default bitwise copy construction.

◆ ~cloudFunctionObjectUList()

~cloudFunctionObjectUList ( )

virtual

Destructor.

Definition at line 93 of file cloudFunctionObjectUList.C.

References forAll.

Member Function Documentation

◆ TypeName()

TypeName ( "cloudFunctionObjectUList" )

Runtime type information.

◆ calculate()

void calculate	(	const LagrangianSubScalarField &	deltaT,
		const bool	final
	)

virtual

Solve equations and/or update continually changing properties.

Definition at line 106 of file cloudFunctionObjectUList.C.

References forAll.

Referenced by cloud::solve().

Here is the caller graph for this function:

◆ preCrossFaces() [1/2]

void preCrossFaces ( const LagrangianScalarInternalDynamicField & fraction )

virtual

Hook before face crossings.

Definition at line 119 of file cloudFunctionObjectUList.C.

References LagrangianMesh::boundary(), Foam::first(), forAll, Foam::inInternalMesh, LagrangianBoundaryMesh::mesh(), patchi, LagrangianMesh::sub(), and LagrangianSubMesh::sub().

Referenced by cloud::solve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ preCrossFaces() [2/2]

virtual void preCrossFaces ( const LagrangianSubScalarSubField & fraction )

virtual

Hook before face crossings of a specific sub-mesh.

◆ postCrossFaces() [1/2]

void postCrossFaces ( const LagrangianSubScalarSubField & fraction )

virtual

Hook following face crossings of a specific sub-mesh.

Definition at line 161 of file cloudFunctionObjectUList.C.

References forAll.

Referenced by patchInjection::modify(), and cloud::solve().

Here is the caller graph for this function:

◆ postCrossFaces() [2/2]

virtual void postCrossFaces ( const LagrangianScalarInternalDynamicField & fraction )

virtual

Hook after face crossings.

◆ operator=()

void operator= ( const cloudFunctionObjectUList & )

delete

Disallow default bitwise assignment.

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

src/Lagrangian/cloud/cloudFunctionObject/cloudFunctionObjectUList.H
src/Lagrangian/cloud/cloudFunctionObject/cloudFunctionObjectUList.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ cloudFunctionObjectUList() [1/2]

◆ cloudFunctionObjectUList() [2/2]

◆ ~cloudFunctionObjectUList()

Member Function Documentation

◆ TypeName()

◆ calculate()

◆ preCrossFaces() [1/2]

◆ preCrossFaces() [2/2]

◆ postCrossFaces() [1/2]

◆ postCrossFaces() [2/2]

◆ operator=()