List of particle forces. More...

Inheritance diagram for ParticleForceList< CloudType >:

Collaboration diagram for ParticleForceList< CloudType >:

Public Member Functions
	ParticleForceList (CloudType &owner, const fvMesh &mesh)
	Null constructor. More...

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

	ParticleForceList (const ParticleForceList &pfl)
	Construct copy. More...

virtual	~ParticleForceList ()
	Destructor. More...

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

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

const fvMesh &	mesh () const
	Return the mesh database. More...

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

void	setCalcCoupled (bool flag)
	Set the calcCoupled flag. More...

void	setCalcNonCoupled (bool flag)
	Set the calcNonCoupled flag. More...

virtual void	cacheFields (const bool store)
	Cache fields. More...

virtual forceSuSp	calcCoupled (const typename CloudType::parcelType &p, const typename CloudType::parcelType::trackingData &td, const scalar dt, const scalar mass, const scalar Re, const scalar muc) const
	Calculate the coupled force. More...

virtual forceSuSp	calcNonCoupled (const typename CloudType::parcelType &p, const typename CloudType::parcelType::trackingData &td, const scalar dt, const scalar mass, const scalar Re, const scalar muc) const
	Calculate the non-coupled force. More...

virtual scalar	massEff (const typename CloudType::parcelType &p, const typename CloudType::parcelType::trackingData &td, const scalar mass) const
	Return the effective mass. More...

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

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

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

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

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

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

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

	PtrList (const SLPtrList< ParticleForce< 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< ParticleForce< CloudType > >	clone (Args &&... args) const
	Make a copy by cloning each of the list elements. More...

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

const ParticleForce< CloudType > *	set (const label i) const

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

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

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

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

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

autoPtr< ParticleForce< CloudType > >	set (const label i, const tmp< ParticleForce< 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 (ParticleForce< CloudType > *ptr)
	Append an element to the end of the list. More...

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

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

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

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

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

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

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

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

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

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

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

void	operator= (PtrList< ParticleForce< 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...

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

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

Detailed Description

template<class CloudType>
class Foam::ParticleForceList< CloudType >

List of particle forces.

Source files

Definition at line 53 of file ParticleForceList.H.

Constructor & Destructor Documentation

◆ ParticleForceList() [1/3]

ParticleForceList	(	CloudType &	owner,
		const fvMesh &	mesh
	)

Null constructor.

Definition at line 35 of file ParticleForceList.C.

◆ ParticleForceList() [2/3]

ParticleForceList	(	CloudType &	owner,
		const fvMesh &	mesh,
		const dictionary &	dict,
		const bool	readFields
	)

Construct from mesh.

Definition at line 51 of file ParticleForceList.C.

References ParticleForceList< CloudType >::dict(), Foam::endl(), Foam::Info, Foam::readFields(), PtrList< ParticleForce< CloudType > >::resize(), and PtrList< ParticleForce< CloudType > >::set().

Here is the call graph for this function:

◆ ParticleForceList() [3/3]

ParticleForceList ( const ParticleForceList< CloudType > & pfl )

Construct copy.

Definition at line 116 of file ParticleForceList.C.

◆ ~ParticleForceList()

~ParticleForceList

virtual

Destructor.

Definition at line 131 of file ParticleForceList.C.

Member Function Documentation

◆ owner() [1/2]

const CloudType & owner

inline

Return const access to the cloud owner.

Definition at line 31 of file ParticleForceListI.H.

◆ owner() [2/2]

CloudType & owner

inline

Return reference to the cloud owner.

Definition at line 38 of file ParticleForceListI.H.

◆ mesh()

const Foam::fvMesh & mesh

inline

Return the mesh database.

Definition at line 45 of file ParticleForceListI.H.

◆ dict()

const Foam::dictionary & dict

inline

Return the forces dictionary.

Definition at line 52 of file ParticleForceListI.H.

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

Here is the caller graph for this function:

◆ setCalcCoupled()

void setCalcCoupled ( bool flag )

inline

Set the calcCoupled flag.

Definition at line 59 of file ParticleForceListI.H.

◆ setCalcNonCoupled()

void setCalcNonCoupled ( bool flag )

inline

Set the calcNonCoupled flag.

Definition at line 66 of file ParticleForceListI.H.

◆ cacheFields()

void cacheFields ( const bool store )

virtual

Cache fields.

Definition at line 138 of file ParticleForceList.C.

Referenced by Explicit< CloudType >::cacheFields(), and Implicit< CloudType >::cacheFields().

Here is the caller graph for this function:

◆ calcCoupled()

Foam::forceSuSp calcCoupled	(	const typename CloudType::parcelType &	p,
		const typename CloudType::parcelType::trackingData &	td,
		const scalar	dt,
		const scalar	mass,
		const scalar	Re,
		const scalar	muc
	)		const

virtual

Calculate the coupled force.

Definition at line 148 of file ParticleForceList.C.

◆ calcNonCoupled()

Foam::forceSuSp calcNonCoupled	(	const typename CloudType::parcelType &	p,
		const typename CloudType::parcelType::trackingData &	td,
		const scalar	dt,
		const scalar	mass,
		const scalar	Re,
		const scalar	muc
	)		const

virtual

Calculate the non-coupled force.

Definition at line 173 of file ParticleForceList.C.

References forAll, p, Foam::Re(), and Foam::Zero.

Here is the call graph for this function:

◆ massEff()

Foam::scalar massEff	(	const typename CloudType::parcelType &	p,
		const typename CloudType::parcelType::trackingData &	td,
		const scalar	mass
	)		const

virtual

Return the effective mass.

Definition at line 199 of file ParticleForceList.C.

References forAll, and p.

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

src/lagrangian/intermediate/submodels/ForceTypes/ParticleForceList/ParticleForceList.H
src/lagrangian/intermediate/submodels/ForceTypes/ParticleForceList/ParticleForceList.C
src/lagrangian/intermediate/submodels/ForceTypes/ParticleForceList/ParticleForceListI.H

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ParticleForceList() [1/3]

◆ ParticleForceList() [2/3]

◆ ParticleForceList() [3/3]

◆ ~ParticleForceList()

Member Function Documentation

◆ owner() [1/2]

◆ owner() [2/2]

◆ mesh()

◆ dict()

◆ setCalcCoupled()

◆ setCalcNonCoupled()

◆ cacheFields()

◆ calcCoupled()

◆ calcNonCoupled()

◆ massEff()