List of particle forces. More...

Inheritance diagram for ParticleForceList< CloudType >:

Collaboration diagram for ParticleForceList< CloudType >:

[legend]

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 refernce 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 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 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 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< T > &)
	Copy constructor. More...

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

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

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

	PtrList (const SLPtrList< T > &)
	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 ()

	PtrList (const label s)

	PtrList (const PtrList< T > &a)

	PtrList (const Xfer< PtrList< T > > &lst)

	PtrList (PtrList< T > &a, bool reUse)

	PtrList (const SLPtrList< T > &sll)

	PtrList (Istream &is)

	~PtrList ()
	Destructor. More...

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

bool	empty () const
	Return true if the PtrList 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 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 (T *)
	Append an element at the end of the list. More...

void	append (const autoPtr< T > &)

void	append (const tmp< T > &)

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

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

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

autoPtr< T >	set (const label, T *)
	Set element. Return old element (can be NULL). More...

autoPtr< T >	set (const label, const autoPtr< T > &)

autoPtr< T >	set (const label, const tmp< T > &)

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

PtrList< T > &	operator= (const PtrList< T > &)
	Assignment. More...

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

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

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

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

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

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

Private Attributes
CloudType &	owner_
	Reference to the owner cloud. More...

const fvMesh &	mesh_
	Reference to the mesh database. More...

const dictionary	dict_
	Forces dictionary. More...

bool	calcCoupled_
	Calculate coupled forces flag. More...

bool	calcNonCoupled_
	Calculate non-coupled forces flag. More...

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

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

Data Fields inherited from PtrList< ParticleForce< CloudType > >
const typedef T &	const_reference
	Type that can be used for storing into constant PtrList::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.

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

CloudType & owner

inline

Return const access to the cloud owner.

Definition at line 29 of file ParticleForceListI.H.

◆ owner() [2/2]

CloudType& owner ( )

inline

Return refernce to the cloud owner.

◆ mesh()

const Foam::fvMesh & mesh

inline

Return the mesh database.

Definition at line 43 of file ParticleForceListI.H.

◆ dict()

const Foam::dictionary & dict

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

◆ massEff()

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

virtual

Return the effective mass.

Definition at line 197 of file ParticleForceList.C.

Field Documentation

◆ owner_

CloudType& owner_

private

Reference to the owner cloud.

Definition at line 58 of file ParticleForceList.H.

◆ mesh_

const fvMesh& mesh_

private

Reference to the mesh database.

Definition at line 61 of file ParticleForceList.H.

◆ dict_

const dictionary dict_

private

Forces dictionary.

Definition at line 64 of file ParticleForceList.H.

◆ calcCoupled_

bool calcCoupled_

private

Calculate coupled forces flag.

Definition at line 67 of file ParticleForceList.H.

◆ calcNonCoupled_

bool calcNonCoupled_

private

Calculate non-coupled forces flag.

Definition at line 70 of file ParticleForceList.H.

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

Private Attributes

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

Field Documentation

◆ owner_

◆ mesh_

◆ dict_

◆ calcCoupled_

◆ calcNonCoupled_

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