Base class for clouds. Provides a basic evolution algorithm, models, and a database for caching derived and average fields to avoid unnecessary re-calculation. More...

Inheritance diagram for cloud:

[legend]

Collaboration diagram for cloud:

[legend]

Public Types
enum	contextType { unknown , functionObject , fvModel }
	Context in which this cloud is used. More...

enum	trackingType { linear , parabolic }
	Tracking method. More...

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 Member Functions
	TypeName ("cloud")
	Run-time type information. More...

	declareRunTimeSelectionTable (autoPtr, cloud, polyMesh,(const polyMesh &mesh, const word &name, const contextType context),(mesh, name, context))
	Declare run-time constructor selection table. More...

	cloud (const polyMesh &mesh, const word &name, const contextType context, const IOobject::readOption readOption=IOobject::READ_IF_PRESENT, const IOobject::writeOption writeOption=IOobject::AUTO_WRITE)
	Construct from a mesh and a name. More...

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

virtual	~cloud ()
	Destructor. More...

const LagrangianMesh &	mesh () const
	Access the mesh. More...

Foam::LagrangianModels &	LagrangianModels () const
	Access the models. More...

template<class Type , class ... Args>
CloudStateField< Type > &	stateField (const Args &... args) const
	Add/get a state field to/from the cache. More...

template<class Type , class ... Args>
const CloudDerivedField< Type > &	derivedField (const Args &... args) const
	Add/get a derived field to/from the cache. More...

template<class Type , class ... Args>
const CloudAverageField< Type > &	averageField (const Args &... args) const
	Add/get an average field to/from the cache. More...

virtual void	solve ()
	Solve the cloud's evolution over the current time-step. More...

virtual void	storePosition ()
	Store the positions for use during mapping. More...

virtual void	movePoints (const polyMesh &)
	Update for mesh motion. 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	operator= (const LagrangianMesh &)=delete
	Disallow default bitwise assignment. More...

template<class Type , class ... Args>
Foam::CloudStateField< Type > &	stateField (const Args &... args) const

template<class Type , class ... Args>
const Foam::CloudDerivedField< Type > &	derivedField (const Args &... args) const

template<class Type , class ... Args>
const Foam::CloudAverageField< Type > &	averageField (const Args &... args) const

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

virtual void	rename (const word &newName)
	Rename. 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	modified () const
	Return true if the object's file (or files for objectRegistry) More...

virtual bool	dependenciesModified () const
	Return true if the object's dependencies have been modified. More...

virtual bool	readIfModified ()
	Read object if modified (as set by call to modified) More...

virtual bool	writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool write) const
	Write using given format, version and compression. 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)

Static Public Member Functions
static autoPtr< cloud >	New (const polyMesh &mesh, const word &name, const word &type)
	Selector. More...

static const Foam::cloud &	lookup (const LagrangianMesh &mesh)
	Lookup the cloud associated with a mesh. More...

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

Public Attributes
enum Foam::cloud::contextType	context

enum Foam::cloud::trackingType	tracking

CloudStateField< vector > &	U
	Velocity. More...

Protected Member Functions
virtual void	initialise (const bool predict)
	Initialisation hook. More...

virtual void	partition ()
	Partition hook. More...

virtual tmp< LagrangianSubVectorField >	dUdt (const LagrangianSubMesh &) const =0
	Return the acceleration with which to do second-order tracking. More...

virtual bool	reCalculateModified ()=0
	Do we need to re-calculate particles that are modified? More...

virtual void	calculate (const LagrangianSubScalarField &deltaT, const bool final)
	Update the cloud properties. 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...

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

Detailed Description

Base class for clouds. Provides a basic evolution algorithm, models, and a database for caching derived and average fields to avoid unnecessary re-calculation.

A cloud is a collection of lagrangian particles.

Source files

Definition at line 60 of file cloud.H.

Member Enumeration Documentation

◆ contextType

enum contextType

Context in which this cloud is used.

Enumerator
unknown
functionObject
fvModel

Definition at line 222 of file cloud.H.

◆ trackingType

enum trackingType

Tracking method.

Enumerator
linear
parabolic

Definition at line 225 of file cloud.H.

Constructor & Destructor Documentation

◆ cloud() [1/2]

cloud	(	const polyMesh &	mesh,
		const word &	name,
		const contextType	context,
		const IOobject::readOption	readOption = `IOobject::READ_IF_PRESENT`,
		const IOobject::writeOption	writeOption = `IOobject::AUTO_WRITE`
	)

Construct from a mesh and a name.

Definition at line 511 of file cloud.C.

◆ cloud() [2/2]

cloud ( const cloud & )

delete

Disallow default bitwise copy construction.

◆ ~cloud()

~cloud ( )

virtual

Destructor.

Definition at line 611 of file cloud.C.

Member Function Documentation

◆ initialise()

void initialise ( const bool predict )

protectedvirtual

Initialisation hook.

Reimplemented in particle, parcel, kinematicParticle, and kinematicParcel.

Definition at line 476 of file cloud.C.

Referenced by kinematicParcel::initialise(), kinematicParticle::initialise(), parcel::initialise(), and particle::initialise().

Here is the caller graph for this function:

◆ partition()

void partition ( )

protectedvirtual

Partition hook.

Reimplemented in particle, parcel, kinematicParticle, and kinematicParcel.

Definition at line 484 of file cloud.C.

Referenced by kinematicParcel::partition(), kinematicParticle::partition(), parcel::partition(), and particle::partition().

Here is the caller graph for this function:

◆ dUdt()

virtual tmp<LagrangianSubVectorField> dUdt ( const LagrangianSubMesh & ) const

protectedpure virtual

Return the acceleration with which to do second-order tracking.

Implemented in particle, parcel, kinematicParticle, and kinematicParcel.

◆ reCalculateModified()

virtual bool reCalculateModified ( )

protectedpure virtual

Do we need to re-calculate particles that are modified?

Implemented in particle, parcel, kinematicParticle, and kinematicParcel.

◆ calculate()

void calculate	(	const LagrangianSubScalarField &	deltaT,
		const bool	final
	)

protectedvirtual

Update the cloud properties.

Reimplemented in particle, parcel, kinematicParticle, and kinematicParcel.

Definition at line 492 of file cloud.C.

Referenced by ReactingMultiphaseParcel< ParcelType >::calcDevolatilisation(), and ReactingMultiphaseParcel< ParcelType >::calcSurfaceReactions().

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "cloud" )

Run-time type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		cloud	,
		polyMesh	,
		(const polyMesh &mesh, const word &name, const contextType context)	,
		(mesh, name, context)
	)

Declare run-time constructor selection table.

◆ New()

Foam::autoPtr< Foam::cloud > New	(	const polyMesh &	mesh,
		const word &	name,
		const word &	type
	)

static

Selector.

Definition at line 561 of file cloud.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, Foam::libs, Foam::name(), Foam::nl, dlLibraryTable::open(), and Foam::type().

Here is the call graph for this function:

◆ mesh()

const LagrangianMesh& mesh ( ) const

inline

Access the mesh.

Definition at line 276 of file cloud.H.

◆ lookup()

const Foam::cloud & lookup ( const LagrangianMesh & mesh )

static

Lookup the cloud associated with a mesh.

Definition at line 617 of file cloud.C.

References objectRegistry::lookupObject(), and mesh.

Here is the call graph for this function:

◆ LagrangianModels()

Foam::LagrangianModels & LagrangianModels ( ) const

Access the models.

Definition at line 623 of file cloud.C.

References dictionary::New().

Referenced by cloud::cloud(), and turbulentDispersion::postConstruct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ stateField() [1/2]

CloudStateField<Type>& stateField ( const Args &... args ) const

Add/get a state field to/from the cache.

◆ derivedField() [1/2]

const CloudDerivedField<Type>& derivedField ( const Args &... args ) const

Add/get a derived field to/from the cache.

◆ averageField() [1/2]

const CloudAverageField<Type>& averageField ( const Args &... args ) const

Add/get an average field to/from the cache.

◆ solve()

void solve ( )

virtual

Solve the cloud's evolution over the current time-step.

Reimplemented in particle, parcel, kinematicParticle, and kinematicParcel.

Definition at line 634 of file cloud.C.

References Foam::fvPatchDistWave::calculate(), cloudFunctionObjectUList::calculate(), LagrangianModels::calculate(), autoPtr< T >::clear(), Foam::complete, LagrangianModels::correct(), Foam::decrIndent(), Foam::dimless, Foam::dimTime, Foam::endl(), EVAL_TYPE_DERIVED_PATCH_FIELDS, pimpleNoLoopControl::finalIter(), pimpleNoLoopControl::firstIter(), Foam::FOR_ALL_FIELD_TYPES(), forAll, LagrangianMesh::fractionName, Foam::inCell, Foam::incrIndent(), Foam::Info, Foam::inInternalMesh, objectRegistry::lookupObject(), singleRegionSolutionControl::mesh(), mesh, LagrangianModels::modify(), Foam::name(), pimpleNoLoopControl::nCorr(), OldTimeField< FieldType >::oldTime(), Foam::onPatchZero, patchi, pimple(), cloudFunctionObjectUList::postCrossFaces(), cloudFunctionObjectUList::preCrossFaces(), LagrangianModels::preModify(), Foam::returnReduce(), LagrangianSubMesh::sub(), and autoPtr< T >::valid().

Referenced by kinematicParcel::solve(), kinematicParticle::solve(), parcel::solve(), and particle::solve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ storePosition()

void storePosition ( )

virtual

Store the positions for use during mapping.

Definition at line 919 of file cloud.C.

◆ movePoints()

void movePoints ( const polyMesh & )

virtual

Update for mesh motion.

Definition at line 925 of file cloud.C.

References Foam::cbrt(), and Foam::mag().

Here is the call graph for this function:

◆ topoChange()

void topoChange ( const polyTopoChangeMap & map )

virtual

Update topology using the given map.

Definition at line 931 of file cloud.C.

References Foam::cbrt(), and Foam::mag().

Here is the call graph for this function:

◆ mapMesh()

void mapMesh ( const polyMeshMap & map )

virtual

Update from another mesh using the given map.

Definition at line 939 of file cloud.C.

References Foam::cbrt(), and Foam::mag().

Here is the call graph for this function:

◆ distribute()

void distribute ( const polyDistributionMap & map )

virtual

Redistribute or update using the given distribution map.

Definition at line 947 of file cloud.C.

References Foam::cbrt(), and Foam::mag().

Here is the call graph for this function:

◆ operator=()

void operator= ( const LagrangianMesh & )

delete

Disallow default bitwise assignment.

◆ stateField() [2/2]

Foam::CloudStateField<Type>& stateField ( const Args &... args ) const

Definition at line 34 of file cloudTemplates.C.

References args.

◆ derivedField() [2/2]

const Foam::CloudDerivedField<Type>& derivedField ( const Args &... args ) const

Definition at line 46 of file cloudTemplates.C.

References args.

◆ averageField() [2/2]

const Foam::CloudAverageField<Type>& averageField ( const Args &... args ) const

Definition at line 58 of file cloudTemplates.C.

References args.

Member Data Documentation

◆ context

enum Foam::cloud::contextType context

◆ tracking

enum Foam::cloud::trackingType tracking

◆ U

CloudStateField<vector>& U

Velocity.

Definition at line 228 of file cloud.H.

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

src/Lagrangian/cloud/cloud/cloud.H
src/Lagrangian/cloud/cloud/cloud.C
src/Lagrangian/cloud/cloud/cloudTemplates.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ contextType

◆ trackingType

Constructor & Destructor Documentation

◆ cloud() [1/2]

◆ cloud() [2/2]

◆ ~cloud()

Member Function Documentation

◆ initialise()

◆ partition()

◆ dUdt()

◆ reCalculateModified()

◆ calculate()

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ New()

◆ mesh()

◆ lookup()

◆ LagrangianModels()

◆ stateField() [1/2]

◆ derivedField() [1/2]

◆ averageField() [1/2]

◆ solve()

◆ storePosition()

◆ movePoints()

◆ topoChange()

◆ mapMesh()

◆ distribute()

◆ operator=()

◆ stateField() [2/2]

◆ derivedField() [2/2]

◆ averageField() [2/2]

Member Data Documentation

◆ context

◆ tracking

◆ U