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 references 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 > >
	PtrList ()
	Null Constructor. More...

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

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

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

	PtrList (PtrList< ParticleForce< CloudType > > &&)
	Move constructor. More...

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

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

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

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

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

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

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

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

autoPtr< ParticleForce< CloudType > >	set (const label, const tmp< ParticleForce< CloudType > > &)
	Set element to given tmp<T> and return old element. 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...

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

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

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

	UPtrList (const label)
	Construct with size specified. 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...

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

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

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< ParticleForce< CloudType > >
void	read (Istream &, const INew &inewt)
	Read from Istream using given Istream constructor class. More...

Detailed Description

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

List of particle forces.

Source files

Definition at line 51 of file ParticleForceList.H.

Constructor & Destructor Documentation

◆ ParticleForceList() [1/3]

ParticleForceList	(	CloudType &	owner,
		const fvMesh &	mesh
	)

Null constructor.

Definition at line 33 of file ParticleForceList.C.

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

Here is the caller graph for this function:

◆ ParticleForceList() [2/3]

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

Construct from mesh.

Definition at line 49 of file ParticleForceList.C.

◆ ParticleForceList() [3/3]

ParticleForceList ( const ParticleForceList< CloudType > & pfl )

Construct copy.

Definition at line 117 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 ( ) const

inline

Return const access to the cloud owner.

Definition at line 29 of file ParticleForceListI.H.

◆ owner() [2/2]

CloudType & owner ( )

inline

Return references to the cloud owner.

Definition at line 36 of file ParticleForceListI.H.

◆ mesh()

const Foam::fvMesh & mesh ( ) const

inline

Return the mesh database.

Definition at line 43 of file ParticleForceListI.H.

◆ dict()

const Foam::dictionary & dict ( ) const

inline

Return the forces dictionary.

Definition at line 50 of file ParticleForceListI.H.

◆ setCalcCoupled()

void setCalcCoupled ( bool flag )

inline

Set the calcCoupled flag.

Definition at line 57 of file ParticleForceListI.H.

◆ setCalcNonCoupled()

void setCalcNonCoupled ( bool flag )

inline

Set the calcNonCoupled flag.

Definition at line 64 of file ParticleForceListI.H.

◆ cacheFields()

void cacheFields ( const bool store )

virtual

Cache fields.

Definition at line 138 of file ParticleForceList.C.

◆ 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 149 of file ParticleForceList.C.

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

Here is the caller graph for this function:

◆ 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 174 of file ParticleForceList.C.

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

Here is the caller 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 200 of file ParticleForceList.C.

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

Here is the caller graph for this function:

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

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

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()

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