List of parcel clouds, with the same interface as an individual parcel cloud. This is the object that should be constructed by an fvModel, or any system that can call this class' mesh change functions. A solver should not* construct this object, as that would not provide a mechanism for the mesh change functions to be executed. A solver should construct a parcelClouds object instead. More...

Inheritance diagram for parcelCloudList:

[legend]

Collaboration diagram for parcelCloudList:

[legend]

Public Member Functions
	parcelCloudList (const wordList &cloudNames, const volScalarField &rho, const volVectorField &U, const volScalarField &mu, const dimensionedVector &g)
	Construct specified clouds with given carrier fields. More...

	parcelCloudList (const wordList &cloudNames, const volScalarField &rho, const volVectorField &U, const dimensionedVector &g, const fluidThermo &carrierThermo)
	Construct specified clouds with given carrier fields and thermo. More...

	parcelCloudList (const volScalarField &rho, const volVectorField &U, const volScalarField &mu, const dimensionedVector &g)
	Construct detected clouds with given carrier fields. More...

	parcelCloudList (const volScalarField &rho, const volVectorField &U, const dimensionedVector &g, const fluidThermo &carrierThermo)
	Construct detected clouds with given carrier fields and thermo. More...

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

	~parcelCloudList ()
	Destructor. More...

const tmp< volScalarField >	theta () const
	Return the particle volume fraction field. More...

tmp< fvVectorMatrix >	SU (const volVectorField &U) const
	Return momentum source term [kg m/s^2]. More...

tmp< volVectorField::Internal >	UTrans () const
	Momentum transfer [kg m/s]. More...

tmp< volScalarField::Internal >	UCoeff () const
	Momentum transfer coefficient [kg]. More...

tmp< fvScalarMatrix >	Sh (const volScalarField &hs) const
	Return sensible enthalpy source term [J/s]. More...

tmp< volScalarField::Internal >	hsTrans () const
	Sensible enthalpy transfer [J]. More...

tmp< volScalarField::Internal >	hsCoeff () const
	Sensible enthalpy transfer coefficient [J/K]. More...

tmp< volScalarField >	Ep () const
	Return equivalent particulate emission [kg/m/s^3]. More...

tmp< volScalarField >	ap () const
	Return equivalent particulate absorption [1/m]. More...

tmp< volScalarField >	sigmap () const
	Return equivalent particulate scattering factor [1/m]. More...

tmp< fvScalarMatrix >	SYi (const label speciei, const volScalarField &Yi) const
	Return mass source term for specie [kg/s]. More...

tmp< fvScalarMatrix >	Srho (const volScalarField &rho) const
	Return total mass source term [kg/s]. More...

tmp< volScalarField::Internal >	Srho () const
	Return total mass source [kg/m^3/s]. More...

void	info ()
	Print cloud information. More...

void	evolve ()
	Evolve the cloud. More...

void	storeGlobalPositions ()
	Call this before a topology change. Stores the particles global. More...

void	topoChange (const polyTopoChangeMap &)
	Update topology using the given map. More...

void	mapMesh (const polyMeshMap &)
	Update from another mesh using the given map. More...

void	distribute (const polyDistributionMap &)
	Redistribute or update using the given distribution map. More...

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

Public Member Functions inherited from PtrList< parcelCloud >
	PtrList ()
	Null Constructor. More...

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

	PtrList (const PtrList< parcelCloud > &)
	Copy constructor. More...

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

	PtrList (PtrList< parcelCloud > &&)
	Move constructor. More...

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

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

void	append (const autoPtr< parcelCloud > &)

void	append (const tmp< parcelCloud > &)

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

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

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

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

autoPtr< parcelCloud >	set (const label, const tmp< parcelCloud > &)
	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< parcelCloud > &)
	Assignment operator. More...

void	operator= (PtrList< parcelCloud > &&)
	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...

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

template<class T2 >
UPtrList< const T2 >	convert () const
	Convert to list of different pointer type. 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...

T *	operator() (const label)
	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...

template<class T2 >
Foam::UPtrList< T2 >	convert ()

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

Static Public Attributes
static const word	defaultCloudName
	The default cloud name. More...

static const wordList	defaultCloudNames
	The default cloud names (i.e., a list of length one with the. More...

static const word	cloudNamesName
	The name of the clouds file in which multiple cloud names are. 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< parcelCloud >
void	read (Istream &, const INew &inewt)
	Read from Istream using given Istream constructor class. More...

Detailed Description

List of parcel clouds, with the same interface as an individual parcel cloud. This is the object that should be constructed by an fvModel, or any system that can call this class' mesh change functions. A solver should not* construct this object, as that would not provide a mechanism for the mesh change functions to be executed. A solver should construct a parcelClouds object instead.

Source files

Definition at line 51 of file parcelCloudList.H.

Constructor & Destructor Documentation

◆ parcelCloudList() [1/5]

parcelCloudList	(	const wordList &	cloudNames,
		const volScalarField &	rho,
		const volVectorField &	U,
		const volScalarField &	mu,
		const dimensionedVector &	g
	)

Construct specified clouds with given carrier fields.

Definition at line 83 of file parcelCloudList.C.

References forAll, Foam::constant::physicoChemical::mu, parcelCloud::New(), rho, PtrList< parcelCloud >::set(), PtrList< parcelCloud >::setSize(), List< T >::size(), and U.

Here is the call graph for this function:

◆ parcelCloudList() [2/5]

parcelCloudList	(	const wordList &	cloudNames,
		const volScalarField &	rho,
		const volVectorField &	U,
		const dimensionedVector &	g,
		const fluidThermo &	carrierThermo
	)

Construct specified clouds with given carrier fields and thermo.

Definition at line 104 of file parcelCloudList.C.

References forAll, parcelCloud::New(), rho, PtrList< parcelCloud >::set(), PtrList< parcelCloud >::setSize(), List< T >::size(), and U.

Here is the call graph for this function:

◆ parcelCloudList() [3/5]

parcelCloudList	(	const volScalarField &	rho,
		const volVectorField &	U,
		const volScalarField &	mu,
		const dimensionedVector &	g
	)

Construct detected clouds with given carrier fields.

Definition at line 125 of file parcelCloudList.C.

◆ parcelCloudList() [4/5]

parcelCloudList	(	const volScalarField &	rho,
		const volVectorField &	U,
		const dimensionedVector &	g,
		const fluidThermo &	carrierThermo
	)

Construct detected clouds with given carrier fields and thermo.

Definition at line 137 of file parcelCloudList.C.

◆ parcelCloudList() [5/5]

parcelCloudList ( const parcelCloudList & )

delete

Disallow default bitwise copy construction.

◆ ~parcelCloudList()

~parcelCloudList ( )

Destructor.

Definition at line 151 of file parcelCloudList.C.

Member Function Documentation

◆ theta()

const Foam::tmp< Foam::volScalarField > theta ( ) const

Return the particle volume fraction field.

Definition at line 157 of file parcelCloudList.C.

References Foam::dimless, forAll, GeometricField< Type, PatchField, GeoMesh >::New(), and tmp< T >::ref().

Referenced by incompressibleDenseParticleFluid::incompressibleDenseParticleFluid().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SU()

Foam::tmp< Foam::fvVectorMatrix > SU ( const volVectorField & U ) const

Return momentum source term [kg m/s^2].

Definition at line 177 of file parcelCloudList.C.

References Foam::dimAcceleration, Foam::dimMass, forAll, tmp< T >::ref(), and U.

Here is the call graph for this function:

◆ UTrans()

Foam::tmp< Foam::volVectorField::Internal > UTrans ( ) const

Momentum transfer [kg m/s].

Definition at line 191 of file parcelCloudList.C.

References Foam::dimMass, Foam::dimVelocity, forAll, DimensionedField< Type, GeoMesh >::New(), tmp< T >::ref(), and Foam::Zero.

Here is the call graph for this function:

◆ UCoeff()

Foam::tmp< Foam::volScalarField::Internal > UCoeff ( ) const

Momentum transfer coefficient [kg].

Definition at line 210 of file parcelCloudList.C.

References Foam::dimMass, forAll, DimensionedField< Type, GeoMesh >::New(), tmp< T >::ref(), and Foam::Zero.

Here is the call graph for this function:

◆ Sh()

Foam::tmp< Foam::fvScalarMatrix > Sh ( const volScalarField & hs ) const

Return sensible enthalpy source term [J/s].

Definition at line 229 of file parcelCloudList.C.

References Foam::dimEnergy, Foam::dimTime, forAll, and tmp< T >::ref().

Here is the call graph for this function:

◆ hsTrans()

Foam::tmp< Foam::volScalarField::Internal > hsTrans ( ) const

Sensible enthalpy transfer [J].

Definition at line 243 of file parcelCloudList.C.

References Foam::dimEnergy, forAll, DimensionedField< Type, GeoMesh >::New(), tmp< T >::ref(), and Foam::Zero.

Here is the call graph for this function:

◆ hsCoeff()

Foam::tmp< Foam::volScalarField::Internal > hsCoeff ( ) const

Sensible enthalpy transfer coefficient [J/K].

Definition at line 262 of file parcelCloudList.C.

References Foam::dimEnergy, Foam::dimTemperature, forAll, DimensionedField< Type, GeoMesh >::New(), tmp< T >::ref(), and Foam::Zero.

Here is the call graph for this function:

◆ Ep()

Foam::tmp< Foam::volScalarField > Ep ( ) const

Return equivalent particulate emission [kg/m/s^3].

Definition at line 281 of file parcelCloudList.C.

References Foam::dimLength, Foam::dimMass, Foam::dimTime, forAll, GeometricField< Type, PatchField, GeoMesh >::New(), Foam::pow3(), tmp< T >::ref(), and Foam::Zero.

Here is the call graph for this function:

◆ ap()

Foam::tmp< Foam::volScalarField > ap ( ) const

Return equivalent particulate absorption [1/m].

Definition at line 300 of file parcelCloudList.C.

References Foam::dimLength, Foam::dimless, forAll, GeometricField< Type, PatchField, GeoMesh >::New(), and tmp< T >::ref().

Here is the call graph for this function:

◆ sigmap()

Foam::tmp< Foam::volScalarField > sigmap ( ) const

Return equivalent particulate scattering factor [1/m].

Definition at line 320 of file parcelCloudList.C.

References Foam::dimLength, Foam::dimless, forAll, GeometricField< Type, PatchField, GeoMesh >::New(), and tmp< T >::ref().

Here is the call graph for this function:

◆ SYi()

Foam::tmp< Foam::fvScalarMatrix > SYi	(	const label	speciei,
		const volScalarField &	Yi
	)		const

Return mass source term for specie [kg/s].

Definition at line 339 of file parcelCloudList.C.

References Foam::dimMass, Foam::dimTime, forAll, and tmp< T >::ref().

Here is the call graph for this function:

◆ Srho() [1/2]

Foam::tmp< Foam::fvScalarMatrix > Srho ( const volScalarField & rho ) const

Return total mass source term [kg/s].

Definition at line 354 of file parcelCloudList.C.

References Foam::dimMass, Foam::dimTime, forAll, tmp< T >::ref(), and rho.

Here is the call graph for this function:

◆ Srho() [2/2]

Foam::tmp< Foam::volScalarField::Internal > Srho ( ) const

Return total mass source [kg/m^3/s].

Definition at line 368 of file parcelCloudList.C.

References Foam::dimDensity, Foam::dimTime, forAll, DimensionedField< Type, GeoMesh >::New(), tmp< T >::ref(), and Foam::Zero.

Here is the call graph for this function:

◆ info()

void info ( )

Print cloud information.

Definition at line 387 of file parcelCloudList.C.

References forAll.

◆ evolve()

void evolve ( )

Evolve the cloud.

Definition at line 396 of file parcelCloudList.C.

References forAll.

◆ storeGlobalPositions()

void storeGlobalPositions ( )

Call this before a topology change. Stores the particles global.

positions in the database for use during mapping.

Definition at line 405 of file parcelCloudList.C.

References forAll.

Referenced by parcelClouds::preUpdateMesh().

Here is the caller graph for this function:

◆ topoChange()

void topoChange ( const polyTopoChangeMap & map )

Update topology using the given map.

Definition at line 414 of file parcelCloudList.C.

References forAll.

Referenced by parcelClouds::topoChange().

Here is the caller graph for this function:

◆ mapMesh()

void mapMesh ( const polyMeshMap & map )

Update from another mesh using the given map.

Definition at line 423 of file parcelCloudList.C.

References forAll.

Referenced by parcelClouds::mapMesh().

Here is the caller graph for this function:

◆ distribute()

void distribute ( const polyDistributionMap & map )

Redistribute or update using the given distribution map.

Definition at line 432 of file parcelCloudList.C.

References forAll.

Referenced by parcelClouds::distribute().

Here is the caller graph for this function:

◆ operator=()

void operator= ( const parcelCloudList & )

delete

Disallow default bitwise assignment.

Member Data Documentation

◆ defaultCloudName

const Foam::word defaultCloudName

static

The default cloud name.

Definition at line 74 of file parcelCloudList.H.

◆ defaultCloudNames

const Foam::wordList defaultCloudNames

static

The default cloud names (i.e., a list of length one with the.

defaultCloudName as its value)

Definition at line 78 of file parcelCloudList.H.

◆ cloudNamesName

const Foam::word cloudNamesName

static

The name of the clouds file in which multiple cloud names are.

specified

Definition at line 82 of file parcelCloudList.H.

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

src/lagrangian/parcel/parcelCloud/parcelCloudList.H
src/lagrangian/parcel/parcelCloud/parcelCloudList.C

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ parcelCloudList() [1/5]

◆ parcelCloudList() [2/5]

◆ parcelCloudList() [3/5]

◆ parcelCloudList() [4/5]

◆ parcelCloudList() [5/5]

◆ ~parcelCloudList()

Member Function Documentation

◆ theta()

◆ SU()

◆ UTrans()

◆ UCoeff()

◆ Sh()

◆ hsTrans()

◆ hsCoeff()

◆ Ep()

◆ ap()

◆ sigmap()

◆ SYi()

◆ Srho() [1/2]

◆ Srho() [2/2]

◆ info()

◆ evolve()

◆ storeGlobalPositions()

◆ topoChange()

◆ mapMesh()

◆ distribute()

◆ operator=()

Member Data Documentation

◆ defaultCloudName

◆ defaultCloudNames

◆ cloudNamesName