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
	Return const pointer to element (can be nullptr),. More...

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

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

Additional Inherited Members
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...

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 36 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 52 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 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 ( ) const

inline

Return the mesh database.

Definition at line 45 of file ParticleForceListI.H.

◆ dict()

const Foam::dictionary & dict ( ) const

inline

Return the forces dictionary.

Definition at line 52 of file ParticleForceListI.H.

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

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

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

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

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

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 >