Templated base class for dsmc cloud. More...

Inheritance diagram for DSMCCloud< ParcelType >:

[legend]

Collaboration diagram for DSMCCloud< ParcelType >:

Public Types
typedef ParcelType	parcelType
	Type of parcel the cloud was instantiated for. More...

Public Types inherited from Cloud< ParcelType >
typedef ParcelType	particleType

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

Random &	rndGen ()
	Return references to the random object. 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, 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...

virtual void	autoMap (const polyTopoChangeMap &)
	Remap the particles to the correct cells following mesh change. 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...

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	move (TrackCloudType &cloud, typename ParcelType ::trackingData &td, const scalar trackTime)
	Move the particles. More...

void	autoMap (const polyTopoChangeMap &)
	Remap the cells of particles corresponding to the. 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 >, 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 label nIoObjects=128)
	Construct a sub-registry given an IObject to describe the registry. More...

	objectRegistry (const objectRegistry &)
	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...

virtual 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	names () const
	Return the list of names of the IOobjects. More...

wordList	sortedNames () const
	Return the sorted list of names of the IOobjects. More...

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

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

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

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

template<class Type >
wordList	names (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 found? More...

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

template<class Type >
Type &	lookupObjectRef (const word &name) const
	Lookup and return the object reference 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...

void	addTemporaryObject (const word &name) const
	Add the given name to the set of temporary objects to cache. 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...

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

virtual bool	readIfModified ()
	Read object if modified. 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	names () const

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

template<class Type >
Foam::wordList	names (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)

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

virtual bool	read ()
	Read object. 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 &)

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

word	modelName (const char *name) const
	Return the name of the object within this model. 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...

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 word &typeName, 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)

template<class Name >
Foam::word	modelName (Name name, const word &model)

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

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

	HashTable (Istream &, const label size=128)
	Construct from Istream. 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...

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

bool	insert (const word &, const regIOobject * &newElmt)
	Insert a new hashedEntry. 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...

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 Name >
static word	modelName (Name name, const word &model)
	Return the name of the object within the given model. 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 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...

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
void	setBad (const string &)
	Set the object state to bad. More...

template<class Type >
bool	typeHeaderOk (const bool checkType)
	Read header using typeGlobalFile to find file. More...

Detailed Description

template<class ParcelType>
class Foam::DSMCCloud< ParcelType >

Templated base class for dsmc cloud.

Source files

Definition at line 75 of file DSMCCloud.H.

Member Typedef Documentation

◆ parcelType

typedef ParcelType parcelType

Type of parcel the cloud was instantiated for.

Definition at line 221 of file DSMCCloud.H.

Constructor & Destructor Documentation

◆ DSMCCloud() [1/3]

DSMCCloud	(	const word &	cloudName,
		const fvMesh &	mesh,
		bool	readFields = `true`
	)

Construct given name and mesh, will read Parcels and fields from.

file

Definition at line 470 of file DSMCCloud.C.

References forAll, and Foam::readFields().

Referenced by DSMCCloud< ParcelType >::addNewParcel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DSMCCloud() [2/3]

DSMCCloud	(	const word &	cloudName,
		const fvMesh &	mesh,
		const IOdictionary &	dsmcInitialiseDict
	)

Construct given name, mesh and initialisation dictionary.

Definition at line 703 of file DSMCCloud.C.

References clear().

Here is the call graph for this function:

◆ DSMCCloud() [3/3]

DSMCCloud ( const DSMCCloud< ParcelType > & )

delete

Disallow default bitwise copy construction.

◆ ~DSMCCloud()

~DSMCCloud ( )

virtual

Destructor.

Definition at line 933 of file DSMCCloud.C.

Member Function Documentation

◆ cloudName()

const Foam::word & cloudName ( ) const

inline

Return the cloud type.

Definition at line 34 of file DSMCCloudI.H.

◆ mesh()

const Foam::fvMesh & mesh ( ) const

inline

Return references to the mesh.

Definition at line 41 of file DSMCCloudI.H.

Referenced by FreeStream< CloudType >::autoMap(), SprayCloud< Foam::DSMCCloud >::cloneBare(), MPPICCloud< Foam::DSMCCloud >::cloneBare(), CollidingCloud< Foam::DSMCCloud >::cloneBare(), ReactingCloud< Foam::DSMCCloud >::cloneBare(), ReactingMultiphaseCloud< Foam::DSMCCloud >::cloneBare(), ThermoCloud< Foam::DSMCCloud >::cloneBare(), MomentumCloud< Foam::DSMCCloud >::cloneBare(), FreeStream< CloudType >::inflow(), InjectionModel< CloudType >::inject(), InjectionModel< CloudType >::injectSteadyState(), and GradientDispersionRAS< CloudType >::update().

Here is the caller graph for this function:

◆ particleProperties()

const Foam::IOdictionary & particleProperties ( ) const

inline

Return particle properties dictionary.

Definition at line 49 of file DSMCCloudI.H.

◆ typeIdList()

const Foam::List< Foam::word > & typeIdList ( ) const

inline

Return the idList.

Definition at line 57 of file DSMCCloudI.H.

◆ nParticle()

Foam::scalar nParticle ( ) const

inline

Return the number of real particles represented by one.

parcel

Definition at line 64 of file DSMCCloudI.H.

◆ cellOccupancy()

const Foam::List< Foam::DynamicList< ParcelType * > > & cellOccupancy ( ) const

inline

Return the cell occupancy addressing.

Definition at line 72 of file DSMCCloudI.H.

◆ sigmaTcRMax()

Foam::volScalarField & sigmaTcRMax ( )

inline

Return the sigmaTcRMax field. non-const access to allow.

updating.

Definition at line 79 of file DSMCCloudI.H.

◆ collisionSelectionRemainder()

Foam::scalarField & collisionSelectionRemainder ( )

inline

Return the collision selection remainder field. non-const.

access to allow updating.

Definition at line 87 of file DSMCCloudI.H.

◆ constProps() [1/2]

const Foam::List< typename ParcelType::constantProperties > & constProps ( ) const

inline

Return all of the constant properties.

Definition at line 95 of file DSMCCloudI.H.

Referenced by VariableHardSphere< CloudType >::collide(), LarsenBorgnakkeVariableHardSphere< CloudType >::collide(), MaxwellianThermal< CloudType >::correct(), MixedDiffuseSpecular< CloudType >::correct(), FreeStream< CloudType >::inflow(), VariableHardSphere< CloudType >::sigmaTcR(), and LarsenBorgnakkeVariableHardSphere< CloudType >::sigmaTcR().

Here is the caller graph for this function:

◆ constProps() [2/2]

const ParcelType::constantProperties & constProps ( label typeId ) const

inline

Return the constant properties of the given typeId.

Definition at line 104 of file DSMCCloudI.H.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and Foam::nl.

Here is the call graph for this function:

◆ rndGen()

Foam::Random & rndGen ( )

inline

Return references to the random object.

Definition at line 121 of file DSMCCloudI.H.

Referenced by VariableHardSphere< CloudType >::collide(), LarsenBorgnakkeVariableHardSphere< CloudType >::collide(), MaxwellianThermal< CloudType >::correct(), MixedDiffuseSpecular< CloudType >::correct(), FreeStream< CloudType >::inflow(), StochasticDispersionRAS< CloudType >::update(), GradientDispersionRAS< CloudType >::update(), TAB< CloudType >::update(), and SHF< CloudType >::update().

Here is the caller graph for this function:

◆ qBF()

Foam::volScalarField::Boundary & qBF ( )

inline

Return non-const heat flux boundary field reference.

Definition at line 129 of file DSMCCloudI.H.

◆ fDBF()

Foam::volVectorField::Boundary & fDBF ( )

inline

Return non-const force density at boundary field reference.

Definition at line 137 of file DSMCCloudI.H.

◆ rhoNBF()

Foam::volScalarField::Boundary & rhoNBF ( )

inline

Return non-const number density boundary field reference.

Definition at line 145 of file DSMCCloudI.H.

◆ rhoMBF()

Foam::volScalarField::Boundary & rhoMBF ( )

inline

Return non-const mass density boundary field reference.

Definition at line 153 of file DSMCCloudI.H.

◆ linearKEBF()

Foam::volScalarField::Boundary & linearKEBF ( )

inline

Return non-const linear kinetic energy density boundary.

field reference

Definition at line 161 of file DSMCCloudI.H.

◆ internalEBF()

Foam::volScalarField::Boundary & internalEBF ( )

inline

Return non-const internal energy density boundary field.

reference

Definition at line 169 of file DSMCCloudI.H.

◆ iDofBF()

Foam::volScalarField::Boundary & iDofBF ( )

inline

Return non-const internal degree of freedom density boundary.

field reference

Definition at line 177 of file DSMCCloudI.H.

◆ momentumBF()

Foam::volVectorField::Boundary & momentumBF ( )

inline

Return non-const momentum density boundary field reference.

Definition at line 185 of file DSMCCloudI.H.

◆ boundaryT()

const Foam::volScalarField & boundaryT ( ) const

inline

Return macroscopic temperature.

Definition at line 193 of file DSMCCloudI.H.

Referenced by MaxwellianThermal< CloudType >::correct(), MixedDiffuseSpecular< CloudType >::correct(), and FreeStream< CloudType >::inflow().

Here is the caller graph for this function:

◆ boundaryU()

const Foam::volVectorField & boundaryU ( ) const

inline

Return macroscopic velocity.

Definition at line 201 of file DSMCCloudI.H.

Referenced by MaxwellianThermal< CloudType >::correct(), MixedDiffuseSpecular< CloudType >::correct(), and FreeStream< CloudType >::inflow().

Here is the caller graph for this function:

◆ q()

const Foam::volScalarField & q ( ) const

inline

Return heat flux at surface field.

Definition at line 412 of file DSMCCloudI.H.

◆ fD()

const Foam::volVectorField & fD ( ) const

inline

Return force density at surface field.

Definition at line 419 of file DSMCCloudI.H.

◆ rhoN()

const Foam::volScalarField & rhoN ( ) const

inline

Return the real particle number density field.

Definition at line 427 of file DSMCCloudI.H.

◆ rhoM()

const Foam::volScalarField & rhoM ( ) const

inline

Return the particle mass density field.

Definition at line 434 of file DSMCCloudI.H.

◆ dsmcRhoN()

const Foam::volScalarField & dsmcRhoN ( ) const

inline

Return the field of number of DSMC particles.

Definition at line 442 of file DSMCCloudI.H.

◆ linearKE()

const Foam::volScalarField & linearKE ( ) const

inline

Return the total linear kinetic energy (translational and.

thermal density field

Definition at line 450 of file DSMCCloudI.H.

◆ internalE()

const Foam::volScalarField & internalE ( ) const

inline

Return the internal energy density field.

Definition at line 458 of file DSMCCloudI.H.

◆ iDof()

const Foam::volScalarField & iDof ( ) const

inline

Return the average internal degrees of freedom field.

Definition at line 466 of file DSMCCloudI.H.

◆ momentum()

const Foam::volVectorField & momentum ( ) const

inline

Return the momentum density field.

Definition at line 473 of file DSMCCloudI.H.

◆ equipartitionLinearVelocity()

Foam::vector equipartitionLinearVelocity	(	scalar	temperature,
		scalar	mass
	)

Generate a random velocity sampled from the Maxwellian speed.

distribution

Definition at line 1014 of file DSMCCloud.C.

References DSMCCloud< ParcelType >::equipartitionInternalEnergy(), Foam::constant::physicoChemical::k, and Foam::sqrt().

Referenced by DSMCCloud< ParcelType >::info().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ equipartitionInternalEnergy()

Foam::scalar equipartitionInternalEnergy	(	scalar	temperature,
		direction	internalDegreesOfFreedom
	)

Generate a random internal energy, sampled from the.

equilibrium distribution (Bird eqn 11.22 and 11.23 and adapting code from DSMC3.FOR)

Definition at line 1027 of file DSMCCloud.C.

References Foam::exp(), Foam::constant::physicoChemical::k, Foam::log(), Foam::pow(), and dimensioned< Type >::value().

Referenced by MaxwellianThermal< CloudType >::correct(), MixedDiffuseSpecular< CloudType >::correct(), DSMCCloud< ParcelType >::equipartitionLinearVelocity(), and FreeStream< CloudType >::inflow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ maxwellianAverageSpeed() [1/2]

Foam::scalar maxwellianAverageSpeed	(	scalar	temperature,
		scalar	mass
	)		const

inline

Average particle speed.

Definition at line 338 of file DSMCCloudI.H.

References Foam::constant::physicoChemical::k, Foam::constant::mathematical::pi(), and Foam::sqrt().

Referenced by DSMCCloud< ParcelType >::internalEnergyOfSystem().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ maxwellianAverageSpeed() [2/2]

Foam::scalarField maxwellianAverageSpeed	(	scalarField	temperature,
		scalar	mass
	)		const

inline

Definition at line 350 of file DSMCCloudI.H.

References Foam::constant::physicoChemical::k, DSMCCloud< ParcelType >::maxwellianRMSSpeed(), Foam::constant::mathematical::pi(), and Foam::sqrt().

Here is the call graph for this function:

◆ maxwellianRMSSpeed() [1/2]

Foam::scalar maxwellianRMSSpeed	(	scalar	temperature,
		scalar	mass
	)		const

inline

RMS particle speed.

Definition at line 363 of file DSMCCloudI.H.

References Foam::constant::physicoChemical::k, and Foam::sqrt().

Referenced by DSMCCloud< ParcelType >::maxwellianAverageSpeed().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ maxwellianRMSSpeed() [2/2]

Foam::scalarField maxwellianRMSSpeed	(	scalarField	temperature,
		scalar	mass
	)		const

inline

Definition at line 374 of file DSMCCloudI.H.

References Foam::constant::physicoChemical::k, DSMCCloud< ParcelType >::maxwellianMostProbableSpeed(), and Foam::sqrt().

Here is the call graph for this function:

◆ maxwellianMostProbableSpeed() [1/2]

Foam::scalar maxwellianMostProbableSpeed	(	scalar	temperature,
		scalar	mass
	)		const

inline

Most probable speed.

Definition at line 388 of file DSMCCloudI.H.

References Foam::constant::physicoChemical::k, and Foam::sqrt().

Referenced by FreeStream< CloudType >::inflow(), and DSMCCloud< ParcelType >::maxwellianRMSSpeed().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ maxwellianMostProbableSpeed() [2/2]

Foam::scalarField maxwellianMostProbableSpeed	(	scalarField	temperature,
		scalar	mass
	)		const

inline

Definition at line 400 of file DSMCCloudI.H.

References Foam::constant::physicoChemical::k, and Foam::sqrt().

Here is the call graph for this function:

◆ binaryCollision() [1/2]

const Foam::BinaryCollisionModel< Foam::DSMCCloud< ParcelType > > & binaryCollision ( ) const

inline

Return reference to binary elastic collision model.

Definition at line 209 of file DSMCCloudI.H.

◆ binaryCollision() [2/2]

Foam::BinaryCollisionModel< Foam::DSMCCloud< ParcelType > > & binaryCollision ( )

inline

Return non-const reference to binary elastic collision model.

Definition at line 217 of file DSMCCloudI.H.

◆ wallInteraction() [1/2]

const Foam::WallInteractionModel< Foam::DSMCCloud< ParcelType > > & wallInteraction ( ) const

inline

Return reference to wall interaction model.

Definition at line 225 of file DSMCCloudI.H.

◆ wallInteraction() [2/2]

Foam::WallInteractionModel< Foam::DSMCCloud< ParcelType > > & wallInteraction ( )

inline

Return non-const reference to wall interaction model.

Definition at line 233 of file DSMCCloudI.H.

◆ inflowBoundary() [1/2]

const Foam::InflowBoundaryModel< Foam::DSMCCloud< ParcelType > > & inflowBoundary ( ) const

inline

Return reference to wall interaction model.

Definition at line 241 of file DSMCCloudI.H.

◆ inflowBoundary() [2/2]

Foam::InflowBoundaryModel< Foam::DSMCCloud< ParcelType > > & inflowBoundary ( )

inline

Return non-const reference to wall interaction model.

Definition at line 249 of file DSMCCloudI.H.

◆ massInSystem()

Foam::scalar massInSystem ( ) const

inline

Total mass in system.

Definition at line 256 of file DSMCCloudI.H.

References forAllConstIter, and p.

◆ linearMomentumOfSystem()

Foam::vector linearMomentumOfSystem ( ) const

inline

Total linear momentum of the system.

Definition at line 277 of file DSMCCloudI.H.

References forAllConstIter, p, and Foam::Zero.

◆ linearKineticEnergyOfSystem()

Foam::scalar linearKineticEnergyOfSystem ( ) const

inline

Total linear kinetic energy in the system.

Definition at line 299 of file DSMCCloudI.H.

References forAllConstIter, and p.

◆ internalEnergyOfSystem()

Foam::scalar internalEnergyOfSystem ( ) const

inline

Total internal energy in the system.

Definition at line 321 of file DSMCCloudI.H.

References forAllConstIter, DSMCCloud< ParcelType >::maxwellianAverageSpeed(), and p.

Here is the call graph for this function:

◆ info()

void info ( ) const

Print cloud information.

Definition at line 970 of file DSMCCloud.C.

References Foam::endl(), DSMCCloud< ParcelType >::equipartitionLinearVelocity(), Foam::Info, Foam::mag(), Foam::name(), Foam::nl, Foam::reduce(), and Foam::returnReduce().

Here is the call graph for this function:

◆ dumpParticlePositions()

void dumpParticlePositions ( ) const

Dump particle positions to .obj file.

Definition at line 1063 of file DSMCCloud.C.

References OSstream::flush(), forAllConstIter, Foam::name(), Foam::nl, and timeName.

Here is the call graph for this function:

◆ addNewParcel()

void addNewParcel	(	const vector &	position,
		const label	celli,
		const vector &	U,
		const scalar	Ei,
		const label	typeId
	)

Add new parcel.

Definition at line 454 of file DSMCCloud.C.

References DSMCCloud< ParcelType >::DSMCCloud().

Referenced by FreeStream< CloudType >::inflow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ evolve()

void evolve ( )

Evolve the cloud (move, collide)

Definition at line 940 of file DSMCCloud.C.

References Cloud< ParticleType >::move().

Referenced by ParcelCloud< CloudType >::evolve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clear()

void clear ( )

inline

Clear the Cloud.

Definition at line 480 of file DSMCCloudI.H.

References ILList< LListBase, T >::clear().

Here is the call graph for this function:

◆ autoMap()

void autoMap ( const polyTopoChangeMap & mapper )

virtual

Remap the particles to the correct cells following mesh change.

Reimplemented from cloud.

Reimplemented in MomentumCloud< CloudType >, MomentumCloud< Foam::DSMCCloud >, ThermoCloud< CloudType >, ThermoCloud< Foam::DSMCCloud >, ReactingCloud< CloudType >, ReactingCloud< Foam::DSMCCloud >, ReactingMultiphaseCloud< CloudType >, and ReactingMultiphaseCloud< Foam::DSMCCloud >.

Definition at line 1087 of file DSMCCloud.C.

References Cloud< ParticleType >::autoMap().

Here is the call graph for this function:

◆ operator=()

void operator= ( const DSMCCloud< ParcelType > & )

delete

Disallow default bitwise assignment.

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

src/lagrangian/DSMC/clouds/Templates/DSMCCloud/DSMCCloud.H
src/lagrangian/DSMC/clouds/Templates/DSMCCloud/DSMCCloud.C
src/lagrangian/DSMC/clouds/Templates/DSMCCloud/DSMCCloudI.H

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

template<class ParcelType> class Foam::DSMCCloud< ParcelType >

Member Typedef Documentation

◆ parcelType

Constructor & Destructor Documentation

◆ DSMCCloud() [1/3]

◆ DSMCCloud() [2/3]

◆ DSMCCloud() [3/3]

◆ ~DSMCCloud()

Member Function Documentation

◆ cloudName()

◆ mesh()

◆ particleProperties()

◆ typeIdList()

◆ nParticle()

◆ cellOccupancy()

◆ sigmaTcRMax()

◆ collisionSelectionRemainder()

◆ constProps() [1/2]

◆ constProps() [2/2]

◆ rndGen()

◆ qBF()

◆ fDBF()

◆ rhoNBF()

◆ rhoMBF()

◆ linearKEBF()

◆ internalEBF()

◆ iDofBF()

◆ momentumBF()

◆ boundaryT()

◆ boundaryU()

◆ q()

◆ fD()

◆ rhoN()

◆ rhoM()

◆ dsmcRhoN()

◆ linearKE()

◆ internalE()

◆ iDof()

◆ momentum()

◆ equipartitionLinearVelocity()

◆ equipartitionInternalEnergy()

◆ maxwellianAverageSpeed() [1/2]

◆ maxwellianAverageSpeed() [2/2]

◆ maxwellianRMSSpeed() [1/2]

◆ maxwellianRMSSpeed() [2/2]

◆ maxwellianMostProbableSpeed() [1/2]

◆ maxwellianMostProbableSpeed() [2/2]

◆ binaryCollision() [1/2]

◆ binaryCollision() [2/2]

◆ wallInteraction() [1/2]

◆ wallInteraction() [2/2]

◆ inflowBoundary() [1/2]

◆ inflowBoundary() [2/2]

◆ massInSystem()

◆ linearMomentumOfSystem()

◆ linearKineticEnergyOfSystem()

◆ internalEnergyOfSystem()

◆ info()

◆ dumpParticlePositions()

◆ addNewParcel()

◆ evolve()

◆ clear()

◆ autoMap()

◆ operator=()

template<class ParcelType>
class Foam::DSMCCloud< ParcelType >