Templated base class for momentum cloud. More...

Inheritance diagram for MomentumCloud< CloudType >:

Collaboration diagram for MomentumCloud< CloudType >:

[legend]

Public Types
typedef CloudType	cloudType
	Type of cloud this cloud was instantiated for. More...

typedef CloudType::particleType	parcelType
	Type of parcel the cloud was instantiated for. More...

typedef MomentumCloud< CloudType >	momentumCloudType
	Convenience typedef for this cloud type. More...

typedef ParticleForceList< MomentumCloud< CloudType > >	forceType
	Force models type. More...

typedef CloudFunctionObjectList< MomentumCloud< CloudType > >	functionType
	Function object type. More...

Public Types inherited from DSMCCloud< ParcelType >
typedef ParcelType	parcelType
	Type of parcel the cloud was instantiated for. More...

Public Types inherited from Cloud< ParcelType >
typedef ParcelType	particleType

typedef IDLList< ParcelType >::value_type	value_type

typedef IDLList< ParcelType >::iterator	iterator

typedef IDLList< ParcelType >::const_iterator	const_iterator

Public Types inherited from IOobject
enum	objectState { GOOD , BAD }
	Enumeration defining the valid states of an IOobject. More...

enum	readOption { MUST_READ , MUST_READ_IF_MODIFIED , READ_IF_PRESENT , NO_READ }
	Enumeration defining the read options. More...

enum	writeOption { AUTO_WRITE = 0 , NO_WRITE = 1 }
	Enumeration defining the write options. More...

enum	fileCheckTypes { timeStamp , timeStampMaster , inotify , inotifyMaster }
	Enumeration defining the file checking options. More...

Public Types inherited from HashTable< regIOobject * >
typedef regIOobject *	value_type
	Type of values the HashTable contains. More...

typedef regIOobject * &	reference
	Type that can be used for storing into HashTable::value_type. More...

typedef const regIOobject * &	const_reference
	Type that can be used for storing into constant. More...

typedef label	size_type
	The type that can represent the size of a HashTable. More...

Public Types inherited from UILList< LListBase, T >
typedef T	value_type
	Type of values the DLList contains. More...

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

typedef const T &	const_reference
	Type that can be used for storing into constant. More...

typedef label	size_type
	The type that can represent the size of a DLList. More...

typedef LListBase::iterator	LListBase_iterator

typedef LListBase::const_iterator	LListBase_const_iterator

Public Member Functions
	MomentumCloud (const word &cloudName, const volScalarField &rho, const volVectorField &U, const volScalarField &mu, const dimensionedVector &g, const bool readFields=true)
	Construct given carrier fields. More...

	MomentumCloud (const word &cloudName, const volScalarField &rho, const volVectorField &U, const dimensionedVector &g, const fluidThermo &carrierThermo, const bool readFields=true)
	Construct given carrier fields and thermo. More...

	MomentumCloud (MomentumCloud< CloudType > &c, const word &name)
	Copy constructor with new name. More...

	MomentumCloud (const fvMesh &mesh, const word &name, const MomentumCloud< CloudType > &c)
	Copy constructor with new name - creates bare cloud. More...

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

virtual autoPtr< lagrangian::Cloud< parcelType > >	clone (const word &name)
	Construct and return clone based on (this) with new name. More...

virtual autoPtr< lagrangian::Cloud< parcelType > >	cloneBare (const word &name) const
	Construct and return bare clone based on (this) with new name. More...

virtual	~MomentumCloud ()
	Destructor. More...

const MomentumCloud &	cloudCopy () const
	Return a reference to the cloud copy. More...

const IOdictionary &	particleProperties () const
	Return particle properties dictionary. More...

const IOdictionary &	outputProperties () const
	Return output properties dictionary. More...

IOdictionary &	outputProperties ()
	Return non-const access to the output properties dictionary. More...

const cloudSolution &	solution () const
	Return const access to the solution properties. More...

cloudSolution &	solution ()
	Return access to the solution properties. More...

const parcelType::constantProperties &	constProps () const
	Return the constant properties. More...

parcelType::constantProperties &	constProps ()
	Return access to the constant properties. More...

const dictionary &	subModelProperties () const
	Return reference to the sub-models dictionary. More...

randomGenerator &	rndGen () const
	Return reference to the random generator. More...

distributions::standardNormal &	stdNormal () const
	Return reference to the standard normal distribution. More...

List< DynamicList< parcelType * > > &	cellOccupancy ()
	Return the cell occupancy information for each. More...

const scalarField &	cellLengthScale () const
	Return the cell length scale. More...

const volVectorField &	U () const
	Return carrier gas velocity. More...

const volScalarField &	rho () const
	Return carrier gas density. More...

const volScalarField &	mu () const
	Return carrier gas dynamic viscosity. More...

const dimensionedVector &	g () const
	Gravity. More...

scalar	pAmbient () const
	Return const-access to the ambient pressure. More...

scalar &	pAmbient ()
	Return reference to the ambient pressure. More...

const forceType &	forces () const
	Optional particle forces. More...

forceType &	forces ()
	Return the optional particle forces. More...

functionType &	functions ()
	Optional cloud function objects. More...

const InjectionModelList< MomentumCloud< CloudType > > &	injectors () const
	Return const access to the injection model. More...

InjectionModelList< MomentumCloud< CloudType > > &	injectors ()
	Return reference to the injection model. More...

const DispersionModel< MomentumCloud< CloudType > > &	dispersion () const
	Return const-access to the dispersion model. More...

DispersionModel< MomentumCloud< CloudType > > &	dispersion ()
	Return reference to the dispersion model. More...

const PatchInteractionModel< MomentumCloud< CloudType > > &	patchInteraction () const
	Return const-access to the patch interaction model. More...

PatchInteractionModel< MomentumCloud< CloudType > > &	patchInteraction ()
	Return reference to the patch interaction model. More...

const StochasticCollisionModel< MomentumCloud< CloudType > > &	stochasticCollision () const
	Return const-access to the stochastic collision model. More...

StochasticCollisionModel< MomentumCloud< CloudType > > &	stochasticCollision ()
	Return reference to the stochastic collision model. More...

const SurfaceFilmModel< MomentumCloud< CloudType > > &	surfaceFilm () const
	Return const-access to the surface film model. More...

SurfaceFilmModel< MomentumCloud< CloudType > > &	surfaceFilm ()
	Return reference to the surface film model. More...

const integrationScheme &	UIntegrator () const
	Return reference to velocity integration. More...

tmp< volVectorField::Internal >	UTrans () const
	Return momentum source. More...

volVectorField::Internal &	UTransRef ()
	Access momentum source. More...

tmp< volScalarField::Internal >	UCoeff () const
	Return coefficient for carrier phase U equation. More...

volScalarField::Internal &	UCoeffRef ()
	Access coefficient for carrier phase U equation. More...

tmp< fvVectorMatrix >	SU (const volVectorField &U) const
	Return tmp momentum source term. More...

label	nParcels () const
	Total number of parcels. More...

scalar	massInSystem () const
	Total mass in system. More...

vector	linearMomentumOfSystem () const
	Total linear momentum of the system. More...

scalar	linearKineticEnergyOfSystem () const
	Total linear kinetic energy in the system. More...

scalar	rotationalKineticEnergyOfSystem () const
	Total rotational kinetic energy in the system. More...

scalar	Dij (const label i, const label j) const
	Mean diameter Dij. More...

scalar	Dmin () const
	Min diameter. More...

scalar	Dmax () const
	Max diameter. More...

const tmp< volScalarField >	vDotSweep () const
	Volume swept rate of parcels per cell. More...

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

const tmp< volScalarField >	Y () const
	Return the particle mass fraction field. More...

const tmp< volScalarField >	rhoEff () const
	Return the particle effective density field. More...

bool	cpuLoad () const
	Return true to cache per-cell CPU load. More...

void	setParcelThermoProperties (parcelType &parcel)
	Set parcel thermo properties. More...

void	checkParcelProperties (parcelType &parcel, const label injectori)
	Check parcel properties. More...

void	storeState ()
	Store the current cloud state. More...

void	restoreState ()
	Reset the current cloud to the previously stored state. More...

void	resetSourceTerms ()
	Reset the cloud source terms. More...

template<class Type >
void	relax (DimensionedField< Type, volMesh > &field, const DimensionedField< Type, volMesh > &field0, const word &name) const
	Relax field. More...

template<class Type >
void	scale (DimensionedField< Type, volMesh > &field, const word &name) const
	Scale field. More...

void	relaxSources (const MomentumCloud< CloudType > &cloudOldTime)
	Apply relaxation to (steady state) cloud sources. More...

void	scaleSources ()
	Apply scaling to (transient) cloud sources. More...

void	preEvolve ()
	Pre-evolve. More...

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

template<class TrackCloudType >
void	motion (TrackCloudType &cloud, typename parcelType::trackingData &td)
	Particle motion. More...

void	patchData (const parcelType &p, const polyPatch &pp, vector &normal, vector &Up) const
	Calculate the patch normal and velocity to interact with,. More...

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

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

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

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

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

Public Member Functions inherited from DSMCCloud< ParcelType >
	DSMCCloud (const word &cloudName, const fvMesh &mesh, bool readFields=true)
	Construct given name and mesh, will read Parcels and fields from. More...

	DSMCCloud (const word &cloudName, const fvMesh &mesh, const IOdictionary &dsmcInitialiseDict)
	Construct given name, mesh and initialisation dictionary. More...

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

virtual	~DSMCCloud ()
	Destructor. More...

const word &	cloudName () const
	Return the cloud type. More...

const fvMesh &	mesh () const
	Return references to the mesh. More...

const IOdictionary &	particleProperties () const
	Return particle properties dictionary. More...

const List< word > &	typeIdList () const
	Return the idList. More...

scalar	nParticle () const
	Return the number of real particles represented by one. More...

const List< DynamicList< ParcelType * > > &	cellOccupancy () const
	Return the cell occupancy addressing. More...

volScalarField &	sigmaTcRMax ()
	Return the sigmaTcRMax field. non-const access to allow. More...

scalarField &	collisionSelectionRemainder ()
	Return the collision selection remainder field. non-const. More...

const List< typename ParcelType::constantProperties > &	constProps () const
	Return all of the constant properties. More...

const ParcelType::constantProperties &	constProps (label typeId) const
	Return the constant properties of the given typeId. More...

randomGenerator &	rndGen ()
	Return reference to the random generator. More...

distributions::standardNormal &	stdNormal ()
	Return reference to the standard normal distribution. More...

volScalarField::Boundary &	qBF ()
	Return non-const heat flux boundary field reference. More...

volVectorField::Boundary &	fDBF ()
	Return non-const force density at boundary field reference. More...

volScalarField::Boundary &	rhoNBF ()
	Return non-const number density boundary field reference. More...

volScalarField::Boundary &	rhoMBF ()
	Return non-const mass density boundary field reference. More...

volScalarField::Boundary &	linearKEBF ()
	Return non-const linear kinetic energy density boundary. More...

volScalarField::Boundary &	internalEBF ()
	Return non-const internal energy density boundary field. More...

volScalarField::Boundary &	iDofBF ()
	Return non-const internal degree of freedom density boundary. More...

volVectorField::Boundary &	momentumBF ()
	Return non-const momentum density boundary field reference. More...

const volScalarField &	boundaryT () const
	Return macroscopic temperature. More...

const volVectorField &	boundaryU () const
	Return macroscopic velocity. More...

const volScalarField &	q () const
	Return heat flux at surface field. More...

const volVectorField &	fD () const
	Return force density at surface field. More...

const volScalarField &	rhoN () const
	Return the real particle number density field. More...

const volScalarField &	rhoM () const
	Return the particle mass density field. More...

const volScalarField &	dsmcRhoN () const
	Return the field of number of DSMC particles. More...

const volScalarField &	linearKE () const
	Return the total linear kinetic energy (translational and. More...

const volScalarField &	internalE () const
	Return the internal energy density field. More...

const volScalarField &	iDof () const
	Return the average internal degrees of freedom field. More...

const volVectorField &	momentum () const
	Return the momentum density field. More...

vector	equipartitionLinearVelocity (scalar temperature, scalar mass)
	Generate a random velocity sampled from the Maxwellian speed. More...

scalar	equipartitionInternalEnergy (scalar temperature, direction internalDegreesOfFreedom)
	Generate a random internal energy, sampled from the. More...

scalar	maxwellianAverageSpeed (scalar temperature, scalar mass) const
	Average particle speed. More...

scalarField	maxwellianAverageSpeed (scalarField temperature, scalar mass) const

scalar	maxwellianRMSSpeed (scalar temperature, scalar mass) const
	RMS particle speed. More...

scalarField	maxwellianRMSSpeed (scalarField temperature, scalar mass) const

scalar	maxwellianMostProbableSpeed (scalar temperature, scalar mass) const
	Most probable speed. More...

scalarField	maxwellianMostProbableSpeed (scalarField temperature, scalar mass) const

const BinaryCollisionModel< DSMCCloud< ParcelType > > &	binaryCollision () const
	Return reference to binary elastic collision model. More...

BinaryCollisionModel< DSMCCloud< ParcelType > > &	binaryCollision ()
	Return non-const reference to binary elastic collision model. More...

const WallInteractionModel< DSMCCloud< ParcelType > > &	wallInteraction () const
	Return reference to wall interaction model. More...

WallInteractionModel< DSMCCloud< ParcelType > > &	wallInteraction ()
	Return non-const reference to wall interaction model. More...

const InflowBoundaryModel< DSMCCloud< ParcelType > > &	inflowBoundary () const
	Return reference to wall interaction model. More...

InflowBoundaryModel< DSMCCloud< ParcelType > > &	inflowBoundary ()
	Return non-const reference to wall interaction model. More...

scalar	massInSystem () const
	Total mass in system. More...

vector	linearMomentumOfSystem () const
	Total linear momentum of the system. More...

scalar	linearKineticEnergyOfSystem () const
	Total linear kinetic energy in the system. More...

scalar	internalEnergyOfSystem () const
	Total internal energy in the system. More...

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

void	dumpParticlePositions () const
	Dump particle positions to .obj file. More...

void	addNewParcel (const vector &position, const label celli, label &nLocateBoundaryHits, const vector &U, const scalar Ei, const label typeId)
	Add new parcel. More...

void	evolve ()
	Evolve the cloud (move, collide) More...

void	clear ()
	Clear the Cloud. More...

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

Public Member Functions inherited from Cloud< ParcelType >
const labelList &	patchNbrProc () const
	Map from patch index to the neighbouring processor index. More...

const labelList &	patchNbrProcPatch () const
	Map from patch index to the corresponding patch index on the. More...

const labelListList &	patchNonConformalCyclicPatches () const
	Return map from patch index to connected non-conformal cyclics. More...

	Cloud (const polyMesh &mesh, const word &cloudName, const IDLList< ParcelType > &particles)
	Construct from mesh and a list of particles. More...

	Cloud (const polyMesh &pMesh, const word &cloudName, const bool checkClass=true)
	Construct from mesh by reading from file with given cloud instance. More...

const polyMesh &	pMesh () const
	Return the polyMesh reference. More...

label	size () const
	Return the number of particles in the cloud. More...

bool	cpuLoad () const
	Return true to cache per-cell CPU load. More...

const const_iterator	begin () const

iterator	begin ()

const const_iterator	cbegin () const

const const_iterator	end () const

iterator	end ()

const const_iterator	cend () const

void	clear ()

void	addParticle (ParcelType *pPtr)
	Transfer particle to cloud. More...

void	deleteParticle (ParcelType &)
	Remove particle from cloud and delete. More...

void	deleteLostParticles ()
	Remove lost particles from cloud and delete. More...

void	cloudReset (const Cloud< ParcelType > &c)
	Reset the particles. More...

void	changeTimeStep ()
	Change the particles' state from the end of the previous time. More...

void	move (TrackCloudType &cloud, typename ParticleType::trackingData &td)
	Move the particles. More...

IOobject	fieldIOobject (const word &fieldName, const IOobject::readOption r) const
	Helper to construct IOobject for field and current time. More...

void	checkFieldIOobject (const Cloud< ParcelType > &c, const IOField< DataType > &data) const
	Check lagrangian data field. More...

void	checkFieldFieldIOobject (const Cloud< ParcelType > &c, const CompactIOField< Field< DataType >> &data) const
	Check lagrangian data fieldfield. More...

virtual void	writeFields () const
	Write the field data for the cloud of particles Dummy at. More...

virtual bool	writeObject (IOstream::streamFormat fmt, IOstream::versionNumber ver, IOstream::compressionType cmp, const bool write=true) const
	Write using given format, version and compression. More...

void	writePositions () const
	Write positions to <cloudName>_positions.obj file. More...

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

Public Member Functions inherited from cloud
	TypeName ("cloud")
	Runtime type information. More...

	cloud (const objectRegistry &, const word &cloudName=defaultName)
	Construct for the given objectRegistry and named cloud instance. More...

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

virtual	~cloud ()
	Destructor. More...

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

Public Member Functions inherited from objectRegistry
	TypeName ("objectRegistry")
	Declare type name for this IOobject. More...

	objectRegistry (const Time &db, const label nIoObjects=128)
	Construct the time objectRegistry given an initial estimate. More...

	objectRegistry (const IOobject &io, const fileName &dbDir, const label nIoObjects=128)
	Construct a sub-registry given an IObject to describe the registry. More...

	objectRegistry (const IOobject &io, const label nIoObjects=128)
	Construct a sub-registry given an IObject to describe the registry. More...

	objectRegistry (objectRegistry &&)=default
	Move constructor. More...

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

virtual	~objectRegistry ()
	Destructor. More...

const Time &	time () const
	Return time. More...

const objectRegistry &	parent () const
	Return the parent objectRegistry. More...

const fileName &	dbDir () const
	Local directory path of this objectRegistry relative to the time. More...

fileName	path (const word &instance, const fileName &local="") const
	Return complete path with alternative instance and local. More...

wordList	toc (const word &className) const
	Return the list of names of IOobjects of given class name. More...

wordList	sortedToc (const word &className) const
	Return the sorted list of names of IOobjects of given class name. More...

template<class Type >
wordList	toc () const
	Return the list of names of the IOobjects of given type. More...

template<class Type >
wordList	toc (const wordRe &name) const
	Return the list of objects whose name matches the input regExp. More...

template<class Type >
wordList	toc (const wordReList &name) const
	Return the list of objects whose name matches the input regExp. More...

const objectRegistry &	subRegistry (const word &name, const bool forceCreate=false) const
	Lookup and return a const sub-objectRegistry. Optionally create. More...

template<class Type >
HashTable< const Type * >	lookupClass (const bool strict=false) const
	Lookup and return all objects of the given Type. More...

template<class Type >
HashTable< Type * >	lookupClass (const bool strict=false)
	Lookup and return all objects of the given Type. More...

template<class Type >
bool	foundObject (const word &name) const
	Is the named Type in registry. More...

template<class Type >
const Type &	lookupObject (const word &name) const
	Lookup and return the object of the given Type and name. More...

template<class Type >
Type &	lookupObjectRef (const word &name) const
	Lookup and return the object reference of the given Type. More...

template<class Type >
bool	foundType (const word &group=word::null) const
	Is the Type in registry. More...

template<class Type >
const Type &	lookupType (const word &group=word::null) const
	Lookup and return the object of the given Type. More...

label	getEvent () const
	Return new event number. More...

const objectRegistry &	thisDb () const
	Return the object registry. More...

virtual void	rename (const word &newName)
	Rename. More...

bool	checkIn (regIOobject &) const
	Add an regIOobject to registry. More...

bool	checkOut (regIOobject &) const
	Remove an regIOobject from registry. More...

void	clear ()
	Remove all regIOobject owned by the registry. More...

bool	cacheTemporaryObject (const word &name) const
	Return true if given name is in the cacheTemporaryObjects set. More...

template<class Object >
bool	cacheTemporaryObject (Object &ob) const
	Cache the given object. More...

void	resetCacheTemporaryObject (const regIOobject &ob) const
	Reset the cache state of the given object. More...

bool	checkCacheTemporaryObjects () const
	Check that all objects in the cacheTemporaryObjects set. More...

virtual bool	modified () const
	Return true if any of the object's files have been modified. More...

virtual bool	dependenciesModified () const
	Cache pointers to objects who's dependencies have been modified. More...

virtual bool	readIfModified ()
	Read object if modified. More...

virtual bool	read ()
	Read dependent objects. More...

void	readModifiedObjects ()
	Read the objects that have been modified. More...

void	printToc (Ostream &os) const
	Print the list of object names and their type. More...

virtual bool	writeData (Ostream &) const
	writeData function required by regIOobject but not used More...

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

template<class Type >
Foam::wordList	toc () const

template<class Type >
Foam::wordList	toc (const wordRe &name) const

template<class Type >
Foam::wordList	toc (const wordReList &patterns) const

template<class Type >
Foam::HashTable< const Type * >	lookupClass (const bool strict) const

template<class Type >
Foam::HashTable< Type * >	lookupClass (const bool strict)

fileName	path () const
	Return complete path. More...

Public Member Functions inherited from regIOobject
	TypeName ("regIOobject")
	Runtime type information. More...

	regIOobject (const IOobject &, const bool isTime=false)
	Construct from IOobject. Optional flag for if IOobject is the. More...

	regIOobject (const regIOobject &)
	Copy constructor. More...

	regIOobject (regIOobject &&)
	Move constructor. More...

	regIOobject (const regIOobject &, bool registerCopy)
	Copy constructor, transferring registry registration to copy. More...

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Copy constructor with new name, transferring registry registration. More...

	regIOobject (const IOobject &, const regIOobject &)
	Copy constructor with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

virtual bool	global () const
	Return true if object is global, i.e. same for all processors. More...

virtual bool	globalFile () const
	Return true if object is global, i.e. same for all processors. More...

const fileName &	caseName () const

fileName	path () const
	Return complete path. More...

fileName	objectPath () const
	Return complete path + object name. More...

fileName	filePath () const
	Return complete path + object name if the file exists. More...

bool	checkIn ()
	Add object to registry. More...

bool	checkOut ()
	Remove object from registry. More...

void	addWatch ()
	Add file watch on object (if registered and READ_IF_MODIFIED) More...

bool	registered () const
	Is this object registered with the registry? More...

bool	ownedByRegistry () const
	Is this object owned by the registry? More...

void	store ()
	Transfer ownership of this object to its registry. More...

void	release ()
	Release ownership of this object from its registry. More...

label	eventNo () const
	Event number at last update. More...

label &	eventNo ()
	Event number at last update. More...

bool	upToDate (const regIOobject &) const
	Return true if up-to-date with respect to given object. More...

bool	upToDate (const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

void	setUpToDate ()
	Set up to date (obviously) More...

bool	headerOk ()
	Read and check header info. More...

Istream &	readStream (const word &, const bool read=true)
	Return Istream and check object type against that given. More...

void	close ()
	Close Istream. More...

virtual bool	readData (Istream &)
	Virtual readData function. More...

const labelList &	watchIndices () const
	Return file-monitoring handles. More...

labelList &	watchIndices ()
	Return file-monitoring handles. More...

virtual bool	write (const bool write=true) const
	Write using setting from DB. More...

void	operator= (const IOobject &)=delete
	Assign to IOobject. More...

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

const fileName &	caseName (const bool global) const

fileName	path (const bool global) const
	Return complete path including the processor sub-directory. More...

fileName	objectPath (const bool global) const
	Return complete path + object name including the processor. More...

fileName	filePath (const bool global) const
	Return complete path + object name if the file exists. More...

Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Runtime type information. More...

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, registry, io options. More...

	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, local, registry, io options. More...

	IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from path, registry, io options. More...

	IOobject (const IOobject &io, const objectRegistry &registry)
	Construct from copy resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Construct from copy resetting name. More...

	IOobject (const IOobject &io)=default
	Copy constructor. More...

autoPtr< IOobject >	clone () const
	Clone. More...

autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry. More...

virtual	~IOobject ()
	Destructor. More...

const Time &	time () const
	Return time. More...

const objectRegistry &	db () const
	Return the local objectRegistry. More...

const word &	name () const
	Return name. More...

const word &	headerClassName () const
	Return name of the class name read from header. More...

word &	headerClassName ()
	Return name of the class name read from header. More...

string &	note ()
	Return non-constant access to the optional note. More...

const string &	note () const
	Return the optional note. More...

bool &	registerObject ()
	Register object created from this IOobject with registry if true. More...

bool	registerObject () const
	Register object created from this IOobject with registry if true. More...

readOption	readOpt () const

readOption &	readOpt ()

writeOption	writeOpt () const

writeOption &	writeOpt ()

word	group () const
	Return group (extension part of name) More...

word	member () const
	Return member (name without the extension) More...

const fileName &	rootPath () const

const fileName &	caseName (const bool global) const

fileName &	instance () const
	Return the instance directory, constant, system, <time> etc. More...

void	updateInstance () const
	If the instance is a time directory update to the current time. More...

void	updateTimeInstance () const
	Update instance to the current time. More...

const fileName &	local () const

fileName	path (const bool global) const
	Return complete path including the processor sub-directory. More...

fileName	objectPath (const bool global) const
	Return complete path + object name including the processor. More...

fileName	relativePath () const
	Return the path relative to the case directory. More...

fileName	relativeObjectPath () const
	Return complete relativePath + object name. More...

fileName	filePath (const bool global) const
	Return complete path + object name if the file exists. More...

bool	readHeader (Istream &)
	Read header. More...

bool	headerOk ()
	Read header of local object without type-checking. More...

template<class Type >
void	warnNoRereading () const
	Helper: warn that type does not support re-reading. More...

bool	writeHeader (Ostream &) const
	Write header. More...

bool	writeHeader (Ostream &, const word &objectType) const
	Write header. Allow override of type. More...

bool	good () const

bool	bad () const

InfoProxy< IOobject >	info () const
	Return info proxy. More...

void	operator= (const IOobject &)

template<class Name >
Foam::word	groupName (Name name, const word &group)

Public Member Functions inherited from HashTable< regIOobject * >
bool	set (const word &, const regIOobject * &newElmt)
	Set a new hashedEntry, overwriting existing entries. More...

void	set (const HashTable< regIOobject *, word, string::hash > &)
	Insert all the entries from the given HashTable,. More...

	HashTable (const label size=128)
	Construct given initial table size. More...

	HashTable (Istream &, const label size=128)
	Construct from Istream. More...

	HashTable (const UList< word > &keyList, const UList< regIOobject * > &elmtList)
	Construct from a list of keys and list of elements. More...

	HashTable (const HashTable< regIOobject *, word, string::hash > &)
	Copy constructor. More...

	HashTable (HashTable< regIOobject *, word, string::hash > &&)
	Move constructor. More...

	HashTable (std::initializer_list< Tuple2< word, regIOobject * >>)
	Construct from an initialiser list. More...

	~HashTable ()
	Destructor. More...

label	capacity () const
	The size of the underlying table. More...

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

bool	empty () const
	Return true if the hash table is empty. More...

bool	found (const word &) const
	Return true if hashedEntry is found in table. More...

iterator	find (const word &)
	Find and return an iterator set at the hashedEntry. More...

const_iterator	find (const word &) const
	Find and return an const_iterator set at the hashedEntry. More...

List< word >	toc () const
	Return the table of contents. More...

List< word >	sortedToc () const
	Return the table of contents as a sorted list. More...

List< const_iterator >	sorted () const
	Return a sorted list of constant iterators. More...

Ostream &	printInfo (Ostream &) const
	Print information. More...

bool	insert (const word &, const regIOobject * &newElmt)
	Insert a new hashedEntry. More...

void	insert (const HashTable< regIOobject *, word, string::hash > &)
	Insert all the entries from the given HashTable. More...

bool	erase (const iterator &)
	Erase a hashedEntry specified by given iterator. More...

bool	erase (const word &)
	Erase a hashedEntry specified by the given key. More...

label	erase (const UList< word > &)
	Remove entries given by the listed keys from this HashTable. More...

label	erase (const HashTable< AnyType, word, AnyHash > &)
	Remove entries given by the given keys from this HashTable. More...

Foam::label	erase (const HashTable< AnyType, word, AnyHash > &rhs)

void	resize (const label newSize)
	Resize the hash table for efficiency. More...

void	clear ()
	Clear all entries from table. More...

void	clearStorage ()
	Clear the table entries and the table itself. More...

void	shrink ()
	Shrink the allocated table to approx. twice number of elements. More...

void	transfer (HashTable< regIOobject *, word, string::hash > &)
	Transfer the contents of the argument table into this table. More...

regIOobject * &	operator[] (const word &)
	Find and return a hashedEntry. More...

const regIOobject * &	operator[] (const word &) const
	Find and return a hashedEntry. More...

regIOobject * &	operator() (const word &)
	Find and return a hashedEntry, create it null if not present. More...

void	operator= (const HashTable< regIOobject *, word, string::hash > &)
	Assignment operator. More...

void	operator= (HashTable< regIOobject *, word, string::hash > &&)
	Move assignment operator. More...

void	operator= (std::initializer_list< Tuple2< word, regIOobject * >>)
	Assignment to an initialiser list. More...

bool	operator== (const HashTable< regIOobject *, word, string::hash > &) const
	Equality. Hash tables are equal if the keys and values are equal. More...

bool	operator!= (const HashTable< regIOobject *, word, string::hash > &) const
	The opposite of the equality operation. Takes linear time. More...

iterator	begin ()
	Iterator set to the beginning of the HashTable. More...

const_iterator	begin () const
	const_iterator set to the beginning of the HashTable More...

const_iterator	cbegin () const
	const_iterator set to the beginning of the HashTable More...

Public Member Functions inherited from HashTableCore
	HashTableCore ()
	Construct null. More...

	ClassName ("HashTable")
	Define template name and debug. More...

Public Member Functions inherited from ILList< LListBase, T >
	ILList ()
	Null construct. More...

	ILList (T *a)
	Construct given initial T. More...

	ILList (Istream &)
	Construct from Istream. More...

	ILList (const ILList< LListBase, T > &)
	Copy constructor. More...

	ILList (ILList< LListBase, T > &&)
	Move constructor. More...

template<class CloneArg >
	ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg)
	Copy constructor with additional argument for clone. More...

template<class INew >
	ILList (Istream &, const INew &)
	Construct from Istream using given Istream constructor class. More...

	~ILList ()
	Destructor. More...

bool	eraseHead ()
	Remove the head element specified from the list and delete it. More...

bool	erase (T *p)
	Remove the specified element from the list and delete it. More...

void	clear ()
	Clear the contents of the list. More...

void	transfer (ILList< LListBase, T > &)
	Transfer the contents of the argument into this List. More...

void	operator= (const ILList< LListBase, T > &)
	Assignment operator. More...

void	operator= (ILList< LListBase, T > &&)
	Move assignment operator. More...

Public Member Functions inherited from UILList< LListBase, T >
	UILList ()
	Null construct. More...

	UILList (T *a)
	Construct given initial T. More...

	UILList (const UILList< LListBase, T > &)
	Copy constructor. More...

	UILList (UILList< LListBase, T > &&)
	Move constructor. More...

T *	first ()
	Return the first entry. More...

const T *	first () const
	Return the first entry. More...

T *	last ()
	Return the last entry. More...

const T *	last () const
	Return the last entry. More...

T *	removeHead ()
	Remove and return head. More...

T *	remove (T *p)
	Remove and return element. More...

T *	remove (iterator &it)
	Remove and return specified by iterator. More...

void	operator= (const UILList< LListBase, T > &)
	Assignment operator. More...

void	operator= (UILList< LListBase, T > &&)
	Move assignment operator. More...

iterator	begin ()

const iterator &	end ()

const_iterator	cbegin () const

const const_iterator &	cend () const

const_iterator	begin () const

const const_iterator &	end () const

const_reverse_iterator	crbegin () const

const const_reverse_iterator &	crend () const

const_reverse_iterator	rbegin () const

const const_reverse_iterator &	rend () const

bool	operator== (const UILList< LListBase, T > &) const
	Equality operation on ULists of the same type. More...

bool	operator!= (const UILList< LListBase, T > &) const
	The opposite of the equality operation. Takes linear time. More...

Protected Member Functions
void	setModels ()
	Set cloud sub-models. More...

template<class TrackCloudType >
void	solve (TrackCloudType &cloud, typename parcelType::trackingData &td)
	Solve the cloud - calls all evolution functions. More...

void	buildCellOccupancy ()
	Build the cellOccupancy. More...

void	updateCellOccupancy ()
	Update (i.e. build) the cellOccupancy if it has. More...

void	postEvolve ()
	Post-evolve. More...

void	cloudReset (MomentumCloud< CloudType > &c)
	Reset state of cloud. More...

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName)
	Read header, check readOpt flags and read data if necessary. More...

Protected Member Functions inherited from IOobject
template<class Type >
bool	typeHeaderOk (const bool checkType)
	Read header using typeGlobalFile to find file. More...

Protected Attributes
IOdictionary	particleProperties_
	Dictionary of particle properties. More...

timeIOdictionary	outputProperties_
	Dictionary of output properties. More...

cloudSolution	solution_
	Solution properties. More...

parcelType::constantProperties	constProps_
	Parcel constant properties. More...

const dictionary	subModelProperties_
	Sub-models dictionary. More...

bool	cpuLoad_
	Switch to enable per-cell CPU load caching for load-balancing. More...

randomGenerator	rndGen_
	Random number generator - used by some injection routines. More...

distributions::standardNormal	stdNormal_
	Standard normal distribution. More...

autoPtr< List< DynamicList< parcelType * > > >	cellOccupancyPtr_
	Cell occupancy information for each parcel, (demand driven) More...

scalarField	cellLengthScale_
	Cell length scale. More...

const volScalarField &	rho_
	Density [kg/m^3]. More...

const volVectorField &	U_
	Velocity [m/s]. More...

const volScalarField &	mu_
	Dynamic viscosity [Pa.s]. More...

const dimensionedVector &	g_
	Gravity. More...

scalar	pAmbient_
	Averaged ambient domain pressure. More...

forceType	forces_
	Optional particle forces. More...

functionType	functions_
	Optional cloud function objects. More...

InjectionModelList< MomentumCloud< CloudType > >	injectors_
	Injector models. More...

autoPtr< DispersionModel< MomentumCloud< CloudType > > >	dispersionModel_
	Dispersion model. More...

autoPtr< PatchInteractionModel< MomentumCloud< CloudType > > >	patchInteractionModel_
	Patch interaction model. More...

autoPtr< StochasticCollisionModel< MomentumCloud< CloudType > > >	stochasticCollisionModel_
	Stochastic collision model. More...

autoPtr< SurfaceFilmModel< MomentumCloud< CloudType > > >	filmModel_
	Optional film model. More...

autoPtr< integrationScheme >	UIntegrator_
	Velocity integration. More...

autoPtr< volVectorField::Internal >	UTrans_
	Momentum. More...

autoPtr< volScalarField::Internal >	UCoeff_
	Coefficient for carrier phase U equation. More...

Additional Inherited Members
Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *)
	Transfer ownership of the given object pointer to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &)
	Transfer ownership of the given object pointer to its registry. More...

Static Public Member Functions inherited from IOobject
static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...

template<class Name >
static word	groupName (Name name, const word &group)

static word	group (const word &name)
	Return group (extension part of name) More...

static word	member (const word &name)
	Return member (name without the extension) More...

template<class Stream >
static Stream &	writeBanner (Stream &os, bool noHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

template<class Stream >
static Stream &	writeDivider (Stream &os)
	Write the standard file section divider. More...

template<class Stream >
static Stream &	writeEndDivider (Stream &os)
	Write the standard end file divider. More...

Static Public Member Functions inherited from HashTableCore
static label	canonicalSize (const label)
	Return a canonical (power-of-two) size. More...

static iteratorEnd	cend ()
	iteratorEnd set to beyond the end of any HashTable More...

static iteratorEnd	end ()
	iteratorEnd set to beyond the end of any HashTable More...

Static Public Attributes inherited from Cloud< ParcelType >
static word	cloudPropertiesName
	Name of cloud properties dictionary. More...

Static Public Attributes inherited from cloud
static const word	prefix
	The prefix to local: lagrangian. More...

static const word	defaultName
	The default cloud name: defaultCloud. More...

Static Public Attributes inherited from regIOobject
static float	fileModificationSkew

Static Public Attributes inherited from IOobject
static constexpr const char *	foamFile = "FoamFile"
	Keyword for the FoamFile header sub-dictionary. More...

static const NamedEnum< fileCheckTypes, 4 >	fileCheckTypesNames

static fileCheckTypes	fileModificationChecking
	Type of file modification checking. More...

Static Public Attributes inherited from HashTableCore
static const label	maxTableSize
	Maximum allowable table size. More...

Detailed Description

template<class CloudType>
class Foam::MomentumCloud< CloudType >

Templated base class for momentum cloud.

cloud function objects
particle forces, e.g.
- buoyancy
- drag
- pressure gradient
- ...
sub-models:
- dispersion model
- injection model
- patch interaction model
- stochastic collision model
- surface film model

Source files

Definition at line 105 of file MomentumCloud.H.

Member Typedef Documentation

◆ cloudType

typedef CloudType cloudType

Type of cloud this cloud was instantiated for.

Definition at line 115 of file MomentumCloud.H.

◆ parcelType

typedef CloudType::particleType parcelType

Type of parcel the cloud was instantiated for.

Definition at line 118 of file MomentumCloud.H.

◆ momentumCloudType

typedef MomentumCloud<CloudType> momentumCloudType

Convenience typedef for this cloud type.

Definition at line 121 of file MomentumCloud.H.

◆ forceType

typedef ParticleForceList<MomentumCloud<CloudType> > forceType

Force models type.

Definition at line 124 of file MomentumCloud.H.

◆ functionType

typedef CloudFunctionObjectList<MomentumCloud<CloudType> > functionType

Function object type.

Definition at line 128 of file MomentumCloud.H.

Constructor & Destructor Documentation

◆ MomentumCloud() [1/5]

MomentumCloud	(	const word &	cloudName,
		const volScalarField &	rho,
		const volVectorField &	U,
		const volScalarField &	mu,
		const dimensionedVector &	g,
		const bool	readFields = `true`
	)

Construct given carrier fields.

Definition at line 260 of file MomentumCloud.C.

References Cloud< ParcelType >::deleteLostParticles(), Foam::readFields(), cloudSolution::resetSourcesOnStartup(), MomentumCloud< CloudType >::resetSourceTerms(), MomentumCloud< CloudType >::setModels(), and MomentumCloud< CloudType >::solution_.

Referenced by MomentumCloud< CloudType >::clone(), and MomentumCloud< CloudType >::cloneBare().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MomentumCloud() [2/5]

MomentumCloud	(	const word &	cloudName,
		const volScalarField &	rho,
		const volVectorField &	U,
		const dimensionedVector &	g,
		const fluidThermo &	carrierThermo,
		const bool	readFields = `true`
	)

Construct given carrier fields and thermo.

Definition at line 386 of file MomentumCloud.C.

◆ MomentumCloud() [3/5]

MomentumCloud	(	MomentumCloud< CloudType > &	c,
		const word &	name
	)

Copy constructor with new name.

Definition at line 401 of file MomentumCloud.C.

◆ MomentumCloud() [4/5]

MomentumCloud	(	const fvMesh &	mesh,
		const word &	name,
		const MomentumCloud< CloudType > &	c
	)

Copy constructor with new name - creates bare cloud.

Definition at line 468 of file MomentumCloud.C.

◆ MomentumCloud() [5/5]

MomentumCloud ( const MomentumCloud< CloudType > & )

delete

Disallow default bitwise copy construction.

◆ ~MomentumCloud()

~MomentumCloud

virtual

Destructor.

Definition at line 531 of file MomentumCloud.C.

Member Function Documentation

◆ setModels()

void setModels

protected

Set cloud sub-models.

Definition at line 40 of file MomentumCloud.C.

References Foam::compressible::New().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ solve()

void solve	(	TrackCloudType &	cloud,
		typename parcelType::trackingData &	td
	)

protected

Solve the cloud - calls all evolution functions.

Definition at line 91 of file MomentumCloud.C.

References IOobject::info().

Here is the call graph for this function:

◆ buildCellOccupancy()

void buildCellOccupancy

protected

Build the cellOccupancy.

Definition at line 162 of file MomentumCloud.C.

References cellOccupancy, forAll, forAllIter, and mesh.

◆ updateCellOccupancy()

void updateCellOccupancy

protected

Update (i.e. build) the cellOccupancy if it has.

already been used

Definition at line 194 of file MomentumCloud.C.

◆ postEvolve()

void postEvolve

protected

Post-evolve.

Definition at line 207 of file MomentumCloud.C.

References Foam::endl(), and Foam::Info.

Here is the call graph for this function:

◆ cloudReset()

void cloudReset ( MomentumCloud< CloudType > & c )

protected

Reset state of cloud.

Definition at line 238 of file MomentumCloud.C.

References Foam::constant::universal::c.

◆ clone()

virtual autoPtr<lagrangian::Cloud<parcelType> > clone ( const word & name )

inlinevirtual

Construct and return clone based on (this) with new name.

Definition at line 313 of file MomentumCloud.H.

References MomentumCloud< CloudType >::MomentumCloud(), and IOobject::name().

Here is the call graph for this function:

◆ cloneBare()

virtual autoPtr<lagrangian::Cloud<parcelType> > cloneBare ( const word & name ) const

inlinevirtual

Construct and return bare clone based on (this) with new name.

Definition at line 322 of file MomentumCloud.H.

References DSMCCloud< ParcelType >::mesh(), and MomentumCloud< CloudType >::MomentumCloud().

Here is the call graph for this function:

◆ cloudCopy()

const Foam::MomentumCloud< CloudType > & cloudCopy

inline

Return a reference to the cloud copy.

Definition at line 32 of file MomentumCloudI.H.

◆ particleProperties()

const Foam::IOdictionary & particleProperties

inline

Return particle properties dictionary.

Definition at line 40 of file MomentumCloudI.H.

◆ outputProperties() [1/2]

const Foam::IOdictionary & outputProperties

inline

Return output properties dictionary.

Definition at line 48 of file MomentumCloudI.H.

◆ outputProperties() [2/2]

Foam::IOdictionary & outputProperties

inline

Return non-const access to the output properties dictionary.

Definition at line 55 of file MomentumCloudI.H.

◆ solution() [1/2]

const Foam::cloudSolution & solution

inline

Return const access to the solution properties.

Definition at line 63 of file MomentumCloudI.H.

◆ solution() [2/2]

Foam::cloudSolution & solution

inline

Return access to the solution properties.

Definition at line 70 of file MomentumCloudI.H.

◆ constProps() [1/2]

const CloudType::particleType::constantProperties & constProps

inline

Return the constant properties.

Definition at line 78 of file MomentumCloudI.H.

◆ constProps() [2/2]

CloudType::particleType::constantProperties & constProps

inline

Return access to the constant properties.

Definition at line 86 of file MomentumCloudI.H.

◆ subModelProperties()

const Foam::dictionary & subModelProperties

inline

Return reference to the sub-models dictionary.

Definition at line 94 of file MomentumCloudI.H.

◆ rndGen()

Foam::randomGenerator & rndGen

inline

Return reference to the random generator.

Definition at line 363 of file MomentumCloudI.H.

◆ stdNormal()

Foam::distributions::standardNormal & stdNormal

inline

Return reference to the standard normal distribution.

Definition at line 371 of file MomentumCloudI.H.

◆ cellOccupancy()

Foam::List< Foam::DynamicList< typename CloudType::particleType * > > & cellOccupancy

inline

Return the cell occupancy information for each.

parcel, non-const access, the caller is responsible for updating it for its own purposes if particles are removed or created.

Definition at line 379 of file MomentumCloudI.H.

◆ cellLengthScale()

const Foam::scalarField & cellLengthScale

inline

Return the cell length scale.

Definition at line 392 of file MomentumCloudI.H.

◆ U()

const Foam::volVectorField & U

inline

Return carrier gas velocity.

Definition at line 108 of file MomentumCloudI.H.

◆ rho()

const Foam::volScalarField & rho

inline

Return carrier gas density.

Definition at line 101 of file MomentumCloudI.H.

◆ mu()

const Foam::volScalarField & mu

inline

Return carrier gas dynamic viscosity.

Definition at line 115 of file MomentumCloudI.H.

◆ g()

const Foam::dimensionedVector & g

inline

Gravity.

Definition at line 122 of file MomentumCloudI.H.

◆ pAmbient() [1/2]

Foam::scalar pAmbient

inline

Return const-access to the ambient pressure.

Definition at line 129 of file MomentumCloudI.H.

◆ pAmbient() [2/2]

Foam::scalar & pAmbient

inline

Return reference to the ambient pressure.

Definition at line 136 of file MomentumCloudI.H.

◆ forces() [1/2]

const Foam::MomentumCloud< CloudType >::forceType & forces

inline

Optional particle forces.

Definition at line 145 of file MomentumCloudI.H.

◆ forces() [2/2]

Foam::MomentumCloud< CloudType >::forceType & forces

inline

Return the optional particle forces.

Definition at line 153 of file MomentumCloudI.H.

◆ functions()

Foam::MomentumCloud< CloudType >::functionType & functions

inline

Optional cloud function objects.

Definition at line 161 of file MomentumCloudI.H.

◆ injectors() [1/2]

const Foam::InjectionModelList< Foam::MomentumCloud< CloudType > > & injectors

inline

Return const access to the injection model.

Definition at line 169 of file MomentumCloudI.H.

◆ injectors() [2/2]

Foam::InjectionModelList< Foam::MomentumCloud< CloudType > > & injectors

inline

Return reference to the injection model.

Definition at line 177 of file MomentumCloudI.H.

◆ dispersion() [1/2]

const Foam::DispersionModel< Foam::MomentumCloud< CloudType > > & dispersion

inline

Return const-access to the dispersion model.

Definition at line 185 of file MomentumCloudI.H.

◆ dispersion() [2/2]

Foam::DispersionModel< Foam::MomentumCloud< CloudType > > & dispersion

inline

Return reference to the dispersion model.

Definition at line 193 of file MomentumCloudI.H.

◆ patchInteraction() [1/2]

const Foam::PatchInteractionModel< Foam::MomentumCloud< CloudType > > & patchInteraction

inline

Return const-access to the patch interaction model.

Definition at line 201 of file MomentumCloudI.H.

◆ patchInteraction() [2/2]

Foam::PatchInteractionModel< Foam::MomentumCloud< CloudType > > & patchInteraction

inline

Return reference to the patch interaction model.

Definition at line 209 of file MomentumCloudI.H.

◆ stochasticCollision() [1/2]

const Foam::StochasticCollisionModel< Foam::MomentumCloud< CloudType > > & stochasticCollision

inline

Return const-access to the stochastic collision model.

Definition at line 217 of file MomentumCloudI.H.

◆ stochasticCollision() [2/2]

Foam::StochasticCollisionModel< Foam::MomentumCloud< CloudType > > & stochasticCollision

inline

Return reference to the stochastic collision model.

Definition at line 225 of file MomentumCloudI.H.

◆ surfaceFilm() [1/2]

const Foam::SurfaceFilmModel< Foam::MomentumCloud< CloudType > > & surfaceFilm

inline

Return const-access to the surface film model.

Definition at line 233 of file MomentumCloudI.H.

◆ surfaceFilm() [2/2]

Foam::SurfaceFilmModel< Foam::MomentumCloud< CloudType > > & surfaceFilm

inline

Return reference to the surface film model.

Definition at line 241 of file MomentumCloudI.H.

◆ UIntegrator()

const Foam::integrationScheme & UIntegrator

inline

Return reference to velocity integration.

Definition at line 249 of file MomentumCloudI.H.

◆ UTrans()

Foam::tmp< Foam::DimensionedField< Foam::vector, Foam::volMesh > > UTrans

inline

Return momentum source.

Definition at line 400 of file MomentumCloudI.H.

◆ UTransRef()

Foam::DimensionedField< Foam::vector, Foam::volMesh > & UTransRef

inline

Access momentum source.

Definition at line 408 of file MomentumCloudI.H.

◆ UCoeff()

Foam::tmp< Foam::DimensionedField< Foam::scalar, Foam::volMesh > > UCoeff

inline

Return coefficient for carrier phase U equation.

Definition at line 416 of file MomentumCloudI.H.

◆ UCoeffRef()

Foam::DimensionedField< Foam::scalar, Foam::volMesh > & UCoeffRef

inline

Access coefficient for carrier phase U equation.

Definition at line 424 of file MomentumCloudI.H.

◆ SU()

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

inline

Return tmp momentum source term.

Definition at line 432 of file MomentumCloudI.H.

References Foam::dimForce, Foam::endl(), Foam::Info, Foam::max(), mesh, Foam::min(), Foam::nl, tmp< T >::ref(), fvMatrix< Type >::source(), Foam::fvc::Sp(), and U.

Here is the call graph for this function:

◆ nParcels()

Foam::label nParcels

inline

Total number of parcels.

Definition at line 256 of file MomentumCloudI.H.

◆ massInSystem()

Foam::scalar massInSystem

inline

Total mass in system.

Definition at line 263 of file MomentumCloudI.H.

References forAllConstIter, and p.

◆ linearMomentumOfSystem()

Foam::vector linearMomentumOfSystem

inline

Total linear momentum of the system.

Definition at line 278 of file MomentumCloudI.H.

References forAllConstIter, p, and Foam::Zero.

◆ linearKineticEnergyOfSystem()

Foam::scalar linearKineticEnergyOfSystem

inline

Total linear kinetic energy in the system.

Definition at line 295 of file MomentumCloudI.H.

References forAllConstIter, and p.

◆ rotationalKineticEnergyOfSystem()

scalar rotationalKineticEnergyOfSystem ( ) const

inline

Total rotational kinetic energy in the system.

◆ Dij()

Foam::scalar Dij	(	const label	i,
		const label	j
	)		const

inline

Mean diameter Dij.

Definition at line 311 of file MomentumCloudI.H.

References forAllConstIter, Foam::max(), p, Foam::pow(), and Foam::reduce().

Here is the call graph for this function:

◆ Dmin()

Foam::scalar Dmin

inline

Min diameter.

Definition at line 335 of file MomentumCloudI.H.

References forAllConstIter, Foam::min(), and Foam::returnReduce().

Here is the call graph for this function:

◆ Dmax()

Foam::scalar Dmax

inline

Max diameter.

Definition at line 349 of file MomentumCloudI.H.

References forAllConstIter, Foam::max(), and Foam::returnReduce().

Here is the call graph for this function:

◆ vDotSweep()

const Foam::tmp< Foam::volScalarField > vDotSweep

inline

Volume swept rate of parcels per cell.

Definition at line 468 of file MomentumCloudI.H.

References GeometricField< Type, GeoMesh, PrimitiveField >::correctBoundaryConditions(), Foam::dimless, Foam::dimTime, forAllConstIter, Foam::mag(), mesh, Foam::name(), Foam::compressible::New(), p, GeometricField< Type, GeoMesh, PrimitiveField >::primitiveFieldRef(), tmp< T >::ref(), and fvMesh::V().

Here is the call graph for this function:

◆ alpha()

const Foam::tmp< Foam::volScalarField > alpha

inline

Return the particle volume fraction field.

Note: for particles belonging to this cloud only

Definition at line 499 of file MomentumCloudI.H.

References alpha(), GeometricField< Type, GeoMesh, PrimitiveField >::correctBoundaryConditions(), Foam::dimless, forAllConstIter, mesh, Foam::name(), Foam::compressible::New(), p, tmp< T >::ref(), and fvMesh::V().

Here is the call graph for this function:

◆ Y()

const Foam::tmp< Foam::volScalarField > Y

inline

Return the particle mass fraction field.

Note: for particles belonging to this cloud only

Definition at line 530 of file MomentumCloudI.H.

References Foam::dimless, forAllConstIter, mesh, Foam::name(), Foam::compressible::New(), p, tmp< T >::ref(), fvMesh::V(), and Y.

Here is the call graph for this function:

◆ rhoEff()

const Foam::tmp< Foam::volScalarField > rhoEff

inline

Return the particle effective density field.

Note: for particles belonging to this cloud only

Definition at line 559 of file MomentumCloudI.H.

References Foam::dimDensity, forAllConstIter, mesh, Foam::name(), Foam::compressible::New(), p, tmp< T >::ref(), and fvMesh::V().

Here is the call graph for this function:

◆ cpuLoad()

bool cpuLoad ( ) const

inline

Return true to cache per-cell CPU load.

Definition at line 547 of file MomentumCloud.H.

References MomentumCloud< CloudType >::cpuLoad_.

◆ setParcelThermoProperties()

void setParcelThermoProperties ( parcelType & parcel )

Set parcel thermo properties.

Definition at line 538 of file MomentumCloud.C.

◆ checkParcelProperties()

void checkParcelProperties	(	parcelType &	parcel,
		const label	injectori
	)

Check parcel properties.

Definition at line 548 of file MomentumCloud.C.

◆ storeState()

void storeState

Store the current cloud state.

Definition at line 562 of file MomentumCloud.C.

References Foam::clone(), and Foam::name().

Here is the call graph for this function:

◆ restoreState()

void restoreState

Reset the current cloud to the previously stored state.

Definition at line 575 of file MomentumCloud.C.

◆ resetSourceTerms()

void resetSourceTerms

Reset the cloud source terms.

Definition at line 583 of file MomentumCloud.C.

References Foam::Zero.

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

Here is the caller graph for this function:

◆ relax()

void relax	(	DimensionedField< Type, volMesh > &	field,
		const DimensionedField< Type, volMesh > &	field0,
		const word &	name
	)		const

Relax field.

Definition at line 592 of file MomentumCloud.C.

References Foam::name().

Here is the call graph for this function:

◆ scale()

void scale	(	DimensionedField< Type, volMesh > &	field,
		const word &	name
	)		const

Scale field.

Definition at line 606 of file MomentumCloud.C.

References Foam::name().

Here is the call graph for this function:

◆ relaxSources()

void relaxSources ( const MomentumCloud< CloudType > & cloudOldTime )

Apply relaxation to (steady state) cloud sources.

Definition at line 618 of file MomentumCloud.C.

References relax(), MomentumCloud< CloudType >::UCoeff_, and MomentumCloud< CloudType >::UTrans_.

Here is the call graph for this function:

◆ scaleSources()

void scaleSources

Apply scaling to (transient) cloud sources.

Definition at line 629 of file MomentumCloud.C.

◆ preEvolve()

void preEvolve

Pre-evolve.

Definition at line 637 of file MomentumCloud.C.

References Foam::endl(), Foam::Info, mesh, Foam::name(), polyMesh::nGeometricD(), and Foam::nl.

Here is the call graph for this function:

◆ evolve()

void evolve

Evolve the cloud.

Definition at line 658 of file MomentumCloud.C.

References Foam::solve().

Here is the call graph for this function:

◆ motion()

void motion	(	TrackCloudType &	cloud,
		typename parcelType::trackingData &	td
	)

Particle motion.

Definition at line 671 of file MomentumCloud.C.

References Cloud< ParcelType >::move().

Here is the call graph for this function:

◆ patchData()

void patchData	(	const parcelType &	p,
		const polyPatch &	pp,
		vector &	normal,
		vector &	Up
	)		const

Calculate the patch normal and velocity to interact with,.

accounting for patch motion if required.

Definition at line 684 of file MomentumCloud.C.

References TimeState::deltaTValue(), patchIdentifier::index(), mesh, p, patchi, fvMesh::time(), and polyPatch::whichFace().

Here is the call graph for this function:

◆ topoChange()

void topoChange ( const polyTopoChangeMap & map )

virtual

Update topology using the given map.

Reimplemented from DSMCCloud< ParcelType >.

Definition at line 725 of file MomentumCloud.C.

References Foam::cbrt(), Foam::mag(), mesh, and Cloud< ParticleType >::topoChange().

Here is the call graph for this function:

◆ mapMesh()

void mapMesh ( const polyMeshMap & map )

virtual

Update from another mesh using the given map.

Reimplemented from DSMCCloud< ParcelType >.

Definition at line 738 of file MomentumCloud.C.

References Foam::cbrt(), Foam::mag(), Cloud< ParticleType >::mapMesh(), and mesh.

Here is the call graph for this function:

◆ distribute()

void distribute ( const polyDistributionMap & map )

virtual

Redistribute or update using the given distribution map.

Reimplemented from DSMCCloud< ParcelType >.

Definition at line 751 of file MomentumCloud.C.

References Foam::cbrt(), Cloud< ParticleType >::distribute(), Foam::mag(), and mesh.

Here is the call graph for this function:

◆ info()

void info

Print cloud information.

Definition at line 764 of file MomentumCloud.C.

References Foam::Info, Foam::mag(), Foam::name(), Foam::nl, Foam::reduce(), and Foam::returnReduce().

Here is the call graph for this function:

◆ operator=()

void operator= ( const MomentumCloud< CloudType > & )

delete

Disallow default bitwise assignment.

Member Data Documentation

◆ particleProperties_

IOdictionary particleProperties_

protected

Dictionary of particle properties.

Definition at line 144 of file MomentumCloud.H.

◆ outputProperties_

timeIOdictionary outputProperties_

protected

Dictionary of output properties.

Definition at line 147 of file MomentumCloud.H.

◆ solution_

cloudSolution solution_

protected

Solution properties.

Definition at line 150 of file MomentumCloud.H.

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

◆ constProps_

parcelType::constantProperties constProps_

protected

Parcel constant properties.

Definition at line 153 of file MomentumCloud.H.

◆ subModelProperties_

const dictionary subModelProperties_

protected

Sub-models dictionary.

Definition at line 156 of file MomentumCloud.H.

◆ cpuLoad_

bool cpuLoad_

protected

Switch to enable per-cell CPU load caching for load-balancing.

Definition at line 159 of file MomentumCloud.H.

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

◆ rndGen_

randomGenerator rndGen_

mutableprotected

Random number generator - used by some injection routines.

Definition at line 162 of file MomentumCloud.H.

◆ stdNormal_

distributions::standardNormal stdNormal_

mutableprotected

Standard normal distribution.

Definition at line 165 of file MomentumCloud.H.

◆ cellOccupancyPtr_

autoPtr<List<DynamicList<parcelType*> > > cellOccupancyPtr_

protected

Cell occupancy information for each parcel, (demand driven)

Definition at line 168 of file MomentumCloud.H.

◆ cellLengthScale_

scalarField cellLengthScale_

protected

Cell length scale.

Definition at line 171 of file MomentumCloud.H.

◆ rho_

const volScalarField& rho_

protected

Density [kg/m^3].

Definition at line 177 of file MomentumCloud.H.

◆ U_

const volVectorField& U_

protected

Velocity [m/s].

Definition at line 180 of file MomentumCloud.H.

◆ mu_

const volScalarField& mu_

protected

Dynamic viscosity [Pa.s].

Definition at line 183 of file MomentumCloud.H.

◆ g_

const dimensionedVector& g_

protected

Gravity.

Definition at line 189 of file MomentumCloud.H.

◆ pAmbient_

scalar pAmbient_

protected

Averaged ambient domain pressure.

Definition at line 192 of file MomentumCloud.H.

◆ forces_

forceType forces_

protected

Optional particle forces.

Definition at line 196 of file MomentumCloud.H.

◆ functions_

functionType functions_

protected

Optional cloud function objects.

Definition at line 199 of file MomentumCloud.H.

◆ injectors_

InjectionModelList<MomentumCloud<CloudType> > injectors_

protected

Injector models.

Definition at line 205 of file MomentumCloud.H.

◆ dispersionModel_

autoPtr<DispersionModel<MomentumCloud<CloudType> > > dispersionModel_

protected

Dispersion model.

Definition at line 209 of file MomentumCloud.H.

◆ patchInteractionModel_

autoPtr<PatchInteractionModel<MomentumCloud<CloudType> > > patchInteractionModel_

protected

Patch interaction model.

Definition at line 213 of file MomentumCloud.H.

◆ stochasticCollisionModel_

autoPtr<StochasticCollisionModel<MomentumCloud<CloudType> > > stochasticCollisionModel_

protected

Stochastic collision model.

Definition at line 217 of file MomentumCloud.H.

◆ filmModel_

autoPtr<SurfaceFilmModel<MomentumCloud<CloudType> > > filmModel_

protected

Optional film model.

Definition at line 220 of file MomentumCloud.H.

◆ UIntegrator_

autoPtr<integrationScheme> UIntegrator_

protected

Velocity integration.

Definition at line 226 of file MomentumCloud.H.

◆ UTrans_

autoPtr<volVectorField::Internal> UTrans_

protected

Momentum.

Definition at line 232 of file MomentumCloud.H.

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

◆ UCoeff_

autoPtr<volScalarField::Internal> UCoeff_

protected

Coefficient for carrier phase U equation.

Definition at line 235 of file MomentumCloud.H.

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

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

src/lagrangian/parcel/clouds/Templates/MomentumCloud/MomentumCloud.H
src/lagrangian/parcel/clouds/Templates/MomentumCloud/MomentumCloud.C
src/lagrangian/parcel/clouds/Templates/MomentumCloud/MomentumCloudI.H

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class CloudType> class Foam::MomentumCloud< CloudType >

Member Typedef Documentation

◆ cloudType

◆ parcelType

◆ momentumCloudType

◆ forceType

◆ functionType

Constructor & Destructor Documentation

◆ MomentumCloud() [1/5]

◆ MomentumCloud() [2/5]

◆ MomentumCloud() [3/5]

◆ MomentumCloud() [4/5]

◆ MomentumCloud() [5/5]

◆ ~MomentumCloud()

Member Function Documentation

◆ setModels()

◆ solve()

◆ buildCellOccupancy()

◆ updateCellOccupancy()

◆ postEvolve()

◆ cloudReset()

◆ clone()

◆ cloneBare()

◆ cloudCopy()

◆ particleProperties()

◆ outputProperties() [1/2]

◆ outputProperties() [2/2]

◆ solution() [1/2]

◆ solution() [2/2]

◆ constProps() [1/2]

◆ constProps() [2/2]

◆ subModelProperties()

◆ rndGen()

◆ stdNormal()

◆ cellOccupancy()

◆ cellLengthScale()

◆ U()

◆ rho()

◆ mu()

◆ g()

◆ pAmbient() [1/2]

◆ pAmbient() [2/2]

◆ forces() [1/2]

◆ forces() [2/2]

◆ functions()

◆ injectors() [1/2]

◆ injectors() [2/2]

◆ dispersion() [1/2]

◆ dispersion() [2/2]

◆ patchInteraction() [1/2]

◆ patchInteraction() [2/2]

◆ stochasticCollision() [1/2]

◆ stochasticCollision() [2/2]

◆ surfaceFilm() [1/2]

◆ surfaceFilm() [2/2]

◆ UIntegrator()

◆ UTrans()

◆ UTransRef()

◆ UCoeff()

◆ UCoeffRef()

◆ SU()

◆ nParcels()

◆ massInSystem()

◆ linearMomentumOfSystem()

◆ linearKineticEnergyOfSystem()

◆ rotationalKineticEnergyOfSystem()

◆ Dij()

◆ Dmin()

◆ Dmax()

◆ vDotSweep()

◆ alpha()

◆ Y()

◆ rhoEff()

◆ cpuLoad()

template<class CloudType>
class Foam::MomentumCloud< CloudType >