Templated base class for kinematic cloud. More...

Inheritance diagram for KinematicCloud< CloudType >:

Collaboration diagram for KinematicCloud< CloudType >:

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 KinematicCloud< CloudType >	kinematicCloudType
	Convenience typedef for this cloud type. More...

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

typedef CloudFunctionObjectList< KinematicCloud< 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< ParticleType >
typedef ParticleType	particleType

typedef ParticleType	parcelType
	Parcels are just particles. More...

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

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

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

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

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

virtual	~KinematicCloud ()=default
	Destructor. More...

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

const fvMesh &	mesh () const
	Return reference to the mesh. 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...

Random &	rndGen () const
	Return reference to the random object. 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< KinematicCloud< CloudType > > &	injectors () const
	Return const access to the injection model. More...

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

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

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

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

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

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

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

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

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

const PackingModel< KinematicCloud< CloudType > > &	packingModel () const
	Return const access to the packing model. More...

PackingModel< KinematicCloud< CloudType > > &	packingModel ()
	Return a reference to the packing model. More...

const DampingModel< KinematicCloud< CloudType > > &	dampingModel () const
	Return const access to the damping model. More...

DampingModel< KinematicCloud< CloudType > > &	dampingModel ()
	Return a reference to the damping model. More...

const IsotropyModel< KinematicCloud< CloudType > > &	isotropyModel () const
	Return const access to the isotropy model. More...

IsotropyModel< KinematicCloud< CloudType > > &	isotropyModel ()
	Return a reference to the isotropy model. More...

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

volVectorField::Internal &	UTrans ()
	Return reference to momentum source. More...

const volVectorField::Internal &	UTrans () const
	Return const reference to momentum source. More...

volScalarField::Internal &	UCoeff ()
	Return coefficient for carrier phase U equation. More...

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

tmp< fvVectorMatrix >	SU (volVectorField &U, bool incompressible=false) const
	Return tmp momentum source term (compressible) More...

virtual 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	totalParticlePerParcel () const
	Average particle per parcel. 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	Dmax () const
	Max diameter. More...

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

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

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

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

void	setParcelThermoProperties (parcelType &parcel, const scalar lagrangianDt)
	Set parcel thermo properties. More...

void	checkParcelProperties (parcelType &parcel, const scalar lagrangianDt, const bool fullyDescribed)
	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 KinematicCloud< CloudType > &cloudOldTime)
	Apply relaxation to (steady state) cloud sources. More...

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

void	preEvolve (const typename parcelType::trackingData &td)
	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...

void	updateMesh ()
	Update mesh. More...

virtual void	autoMap (const mapPolyMesh &)
	Remap the cells of particles corresponding to the. More...

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

virtual void	readObjects (const objectRegistry &obr)
	Read particle fields from objects in the obr registry. More...

virtual void	writeObjects (objectRegistry &obr) const
	Write particle fields as objects into the obr registry. 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...

virtual	~DSMCCloud ()
	Destructor. More...

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

const fvMesh &	mesh () const
	Return reference 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 reference 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...

Public Member Functions inherited from Cloud< ParticleType >
	TypeName ("Cloud")
	Runtime type information. More...

	Cloud (const polyMesh &mesh, const word &cloudName, const IDLList< ParticleType > &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...

DynamicList< label > &	labels () const
	Return temporary addressing. More...

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

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

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

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

template<class TrackCloudType >
void	move (TrackCloudType &cloud, typename ParticleType::trackingData &td, const scalar trackTime)
	Move the particles. More...

void	autoMap (const mapPolyMesh &)
	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...

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

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

template<class Type >
bool	readStoreFile (const IOobject &io, const IOobject &ioNew) const
	Helper function to store a cloud field on its registry. More...

void	readFromFiles (objectRegistry &obr, const wordRes &selectFields) const
	Read from files into objectRegistry. More...

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

virtual bool	writeObject (IOstreamOption streamOpt, const bool valid) const
	Write using stream options. More...

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

void	storeGlobalPositions () const
	Call this before a topology change. More...

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

	DSMCBaseCloud ()=default
	Null constructor. More...

virtual	~DSMCBaseCloud ()=default
	Destructor. More...

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

	kinematicCloud ()=default
	Null constructor. More...

virtual	~kinematicCloud ()=default
	Destructor. 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...

template<class TrackCloudType >
void	evolveCloud (TrackCloudType &cloud, typename parcelType::trackingData &td)
	Evolve the cloud. More...

void	postEvolve (const typename parcelType::trackingData &td)
	Post-evolve. More...

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

Protected Attributes
const fvMesh &	mesh_
	References to the mesh and time databases. More...

IOdictionary	particleProperties_
	Dictionary of particle properties. More...

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

Random	rndGen_
	Random number generator - used by some injection routines. 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/m3]. 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< KinematicCloud< CloudType > >	injectors_
	Injector models. More...

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

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

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

autoPtr< SurfaceFilmModel< KinematicCloud< CloudType > > >	surfaceFilmModel_
	Surface film model. More...

autoPtr< PackingModel< KinematicCloud< CloudType > > >	packingModel_
	Packing model. More...

autoPtr< DampingModel< KinematicCloud< CloudType > > >	dampingModel_
	Damping model. More...

autoPtr< IsotropyModel< KinematicCloud< CloudType > > >	isotropyModel_
	Exchange 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...

Protected Attributes inherited from Cloud< ParticleType >
cloud::geometryType	geometryType_
	Geometry type. More...

Additional Inherited Members
Static Public Attributes inherited from Cloud< ParticleType >
static word	cloudPropertiesName
	Name of cloud properties dictionary. More...

Detailed Description

template<class CloudType>
class Foam::KinematicCloud< CloudType >

Templated base class for kinematic 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 112 of file KinematicCloud.H.

Member Typedef Documentation

◆ cloudType

typedef CloudType cloudType

Type of cloud this cloud was instantiated for.

Definition at line 122 of file KinematicCloud.H.

◆ parcelType

typedef CloudType::particleType parcelType

Type of parcel the cloud was instantiated for.

Definition at line 125 of file KinematicCloud.H.

◆ kinematicCloudType

typedef KinematicCloud<CloudType> kinematicCloudType

Convenience typedef for this cloud type.

Definition at line 128 of file KinematicCloud.H.

◆ forceType

typedef ParticleForceList<KinematicCloud<CloudType> > forceType

Force models type.

Definition at line 131 of file KinematicCloud.H.

◆ functionType

typedef CloudFunctionObjectList<KinematicCloud<CloudType> > functionType

Function object type.

Definition at line 135 of file KinematicCloud.H.

Constructor & Destructor Documentation

◆ KinematicCloud() [1/3]

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

Construct given carrier gas fields.

◆ KinematicCloud() [2/3]

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

Copy constructor with new name.

Definition at line 482 of file KinematicCloud.C.

◆ KinematicCloud() [3/3]

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

Copy constructor with new name - creates bare cloud.

Definition at line 554 of file KinematicCloud.C.

◆ ~KinematicCloud()

virtual ~KinematicCloud ( )

virtualdefault

Destructor.

Member Function Documentation

◆ setModels()

void setModels ( )

protected

Set cloud sub-models.

Definition at line 50 of file KinematicCloud.C.

◆ solve()

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

protected

Solve the cloud - calls all evolution functions.

Definition at line 129 of file KinematicCloud.C.

◆ buildCellOccupancy()

void buildCellOccupancy ( )

protected

Build the cellOccupancy.

Definition at line 173 of file KinematicCloud.C.

◆ updateCellOccupancy()

void updateCellOccupancy ( )

protected

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

already been used

Definition at line 205 of file KinematicCloud.C.

◆ evolveCloud()

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

protected

Evolve the cloud.

Definition at line 220 of file KinematicCloud.C.

◆ postEvolve()

void postEvolve ( const typename parcelType::trackingData & td )

protected

Post-evolve.

Definition at line 266 of file KinematicCloud.C.

◆ cloudReset()

void cloudReset ( KinematicCloud< CloudType > & c )

protected

Reset state of cloud.

Definition at line 312 of file KinematicCloud.C.

◆ clone()

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

inlinevirtual

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

Reimplemented in CollidingCloud< KinematicCloud< Cloud< basicKinematicCollidingParcel > > >.

Definition at line 333 of file KinematicCloud.H.

◆ cloneBare()

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

inlinevirtual

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

Reimplemented in CollidingCloud< KinematicCloud< Cloud< basicKinematicCollidingParcel > > >.

Definition at line 342 of file KinematicCloud.H.

◆ cloudCopy()

const Foam::KinematicCloud< CloudType > & cloudCopy ( ) const

inline

Return a reference to the cloud copy.

Definition at line 35 of file KinematicCloudI.H.

◆ mesh()

const Foam::fvMesh & mesh ( ) const

inline

Return reference to the mesh.

Definition at line 42 of file KinematicCloudI.H.

Referenced by KinematicCloud< Cloud< basicKinematicCollidingParcel > >::cloneBare().

Here is the caller graph for this function:

◆ particleProperties()

const Foam::IOdictionary & particleProperties ( ) const

inline

Return particle properties dictionary.

Definition at line 50 of file KinematicCloudI.H.

◆ outputProperties() [1/2]

const Foam::IOdictionary & outputProperties ( ) const

inline

Return output properties dictionary.

Definition at line 58 of file KinematicCloudI.H.

◆ outputProperties() [2/2]

Foam::IOdictionary & outputProperties ( )

inline

Return non-const access to the output properties dictionary.

Definition at line 65 of file KinematicCloudI.H.

◆ solution() [1/2]

const Foam::cloudSolution & solution ( ) const

inline

Return const access to the solution properties.

Definition at line 73 of file KinematicCloudI.H.

◆ solution() [2/2]

Foam::cloudSolution & solution ( )

inline

Return access to the solution properties.

Definition at line 80 of file KinematicCloudI.H.

◆ constProps() [1/2]

const CloudType::particleType::constantProperties & constProps ( ) const

inline

Return the constant properties.

Definition at line 88 of file KinematicCloudI.H.

◆ constProps() [2/2]

CloudType::particleType::constantProperties & constProps ( )

inline

Return access to the constant properties.

Definition at line 96 of file KinematicCloudI.H.

◆ subModelProperties()

const Foam::dictionary & subModelProperties ( ) const

inline

Return reference to the sub-models dictionary.

Definition at line 104 of file KinematicCloudI.H.

◆ rndGen()

Foam::Random & rndGen ( ) const

inline

Return reference to the random object.

Definition at line 410 of file KinematicCloudI.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 418 of file KinematicCloudI.H.

◆ cellLengthScale()

const Foam::scalarField & cellLengthScale ( ) const

inline

Return the cell length scale.

Definition at line 431 of file KinematicCloudI.H.

◆ U()

const Foam::volVectorField & U ( ) const

inline

Return carrier gas velocity.

Definition at line 118 of file KinematicCloudI.H.

◆ rho()

const Foam::volScalarField & rho ( ) const

inline

Return carrier gas density.

Definition at line 111 of file KinematicCloudI.H.

◆ mu()

const Foam::volScalarField & mu ( ) const

inline

Return carrier gas dynamic viscosity.

Definition at line 125 of file KinematicCloudI.H.

◆ g()

const Foam::dimensionedVector & g ( ) const

inline

Gravity.

Definition at line 132 of file KinematicCloudI.H.

◆ pAmbient() [1/2]

Foam::scalar pAmbient ( ) const

inline

Return const-access to the ambient pressure.

Definition at line 139 of file KinematicCloudI.H.

◆ pAmbient() [2/2]

Foam::scalar & pAmbient ( )

inline

Return reference to the ambient pressure.

Definition at line 146 of file KinematicCloudI.H.

◆ forces() [1/2]

const Foam::KinematicCloud< CloudType >::forceType & forces ( ) const

inline

Optional particle forces.

Definition at line 155 of file KinematicCloudI.H.

◆ forces() [2/2]

Foam::KinematicCloud< CloudType >::forceType & forces ( )

inline

Return the optional particle forces.

Definition at line 163 of file KinematicCloudI.H.

◆ functions()

Foam::KinematicCloud< CloudType >::functionType & functions ( )

inline

Optional cloud function objects.

Definition at line 171 of file KinematicCloudI.H.

◆ injectors() [1/2]

const Foam::InjectionModelList< Foam::KinematicCloud< CloudType > > & injectors ( ) const

inline

Return const access to the injection model.

Definition at line 179 of file KinematicCloudI.H.

◆ injectors() [2/2]

Foam::InjectionModelList< Foam::KinematicCloud< CloudType > > & injectors ( )

inline

Return reference to the injection model.

Definition at line 187 of file KinematicCloudI.H.

◆ dispersion() [1/2]

const Foam::DispersionModel< Foam::KinematicCloud< CloudType > > & dispersion ( ) const

inline

Return const-access to the dispersion model.

Definition at line 195 of file KinematicCloudI.H.

◆ dispersion() [2/2]

Foam::DispersionModel< Foam::KinematicCloud< CloudType > > & dispersion ( )

inline

Return reference to the dispersion model.

Definition at line 203 of file KinematicCloudI.H.

◆ patchInteraction() [1/2]

const Foam::PatchInteractionModel< Foam::KinematicCloud< CloudType > > & patchInteraction ( ) const

inline

Return const-access to the patch interaction model.

Definition at line 211 of file KinematicCloudI.H.

◆ patchInteraction() [2/2]

Foam::PatchInteractionModel< Foam::KinematicCloud< CloudType > > & patchInteraction ( )

inline

Return reference to the patch interaction model.

Definition at line 219 of file KinematicCloudI.H.

◆ stochasticCollision() [1/2]

const Foam::StochasticCollisionModel< Foam::KinematicCloud< CloudType > > & stochasticCollision ( ) const

inline

Return const-access to the stochastic collision model.

Definition at line 227 of file KinematicCloudI.H.

◆ stochasticCollision() [2/2]

Foam::StochasticCollisionModel< Foam::KinematicCloud< CloudType > > & stochasticCollision ( )

inline

Return reference to the stochastic collision model.

Definition at line 235 of file KinematicCloudI.H.

◆ surfaceFilm() [1/2]

const Foam::SurfaceFilmModel< Foam::KinematicCloud< CloudType > > & surfaceFilm ( ) const

inline

Return const-access to the surface film model.

Definition at line 243 of file KinematicCloudI.H.

◆ surfaceFilm() [2/2]

Foam::SurfaceFilmModel< Foam::KinematicCloud< CloudType > > & surfaceFilm ( )

inline

Return reference to the surface film model.

Definition at line 251 of file KinematicCloudI.H.

◆ packingModel() [1/2]

const Foam::PackingModel< Foam::KinematicCloud< CloudType > > & packingModel ( ) const

inline

Return const access to the packing model.

Definition at line 259 of file KinematicCloudI.H.

◆ packingModel() [2/2]

Foam::PackingModel< Foam::KinematicCloud< CloudType > > & packingModel ( )

inline

Return a reference to the packing model.

Definition at line 267 of file KinematicCloudI.H.

◆ dampingModel() [1/2]

const Foam::DampingModel< Foam::KinematicCloud< CloudType > > & dampingModel ( ) const

inline

Return const access to the damping model.

Definition at line 275 of file KinematicCloudI.H.

◆ dampingModel() [2/2]

Foam::DampingModel< Foam::KinematicCloud< CloudType > > & dampingModel ( )

inline

Return a reference to the damping model.

Definition at line 283 of file KinematicCloudI.H.

◆ isotropyModel() [1/2]

const Foam::IsotropyModel< Foam::KinematicCloud< CloudType > > & isotropyModel ( ) const

inline

Return const access to the isotropy model.

Definition at line 291 of file KinematicCloudI.H.

◆ isotropyModel() [2/2]

Foam::IsotropyModel< Foam::KinematicCloud< CloudType > > & isotropyModel ( )

inline

Return a reference to the isotropy model.

Definition at line 299 of file KinematicCloudI.H.

◆ UIntegrator()

const Foam::integrationScheme & UIntegrator ( ) const

inline

Return reference to velocity integration.

Definition at line 307 of file KinematicCloudI.H.

◆ UTrans() [1/2]

Foam::DimensionedField< Foam::vector, Foam::volMesh > & UTrans ( )

inline

Return reference to momentum source.

Definition at line 439 of file KinematicCloudI.H.

Referenced by KinematicCloud< Cloud< basicKinematicCollidingParcel > >::relaxSources().

Here is the caller graph for this function:

◆ UTrans() [2/2]

const Foam::DimensionedField< Foam::vector, Foam::volMesh > & UTrans ( ) const

inline

Return const reference to momentum source.

Definition at line 447 of file KinematicCloudI.H.

◆ UCoeff() [1/2]

Foam::DimensionedField< Foam::scalar, Foam::volMesh > & UCoeff ( )

inline

Return coefficient for carrier phase U equation.

Definition at line 455 of file KinematicCloudI.H.

Referenced by KinematicCloud< Cloud< basicKinematicCollidingParcel > >::relaxSources().

Here is the caller graph for this function:

◆ UCoeff() [2/2]

const Foam::DimensionedField< Foam::scalar, Foam::volMesh > & UCoeff ( ) const

inline

Return const coefficient for carrier phase U equation.

Definition at line 463 of file KinematicCloudI.H.

◆ SU()

Foam::tmp< Foam::fvVectorMatrix > SU	(	volVectorField &	U,
		bool	incompressible = `false`
	)		const

inline

Return tmp momentum source term (compressible)

Definition at line 471 of file KinematicCloudI.H.

◆ nParcels()

virtual label nParcels ( ) const

inlinevirtual

Total number of parcels.

Implements kinematicCloud.

Definition at line 547 of file KinematicCloud.H.

◆ massInSystem()

Foam::scalar massInSystem ( ) const

inlinevirtual

Total mass in system.

Implements kinematicCloud.

Definition at line 314 of file KinematicCloudI.H.

◆ linearMomentumOfSystem()

Foam::vector linearMomentumOfSystem ( ) const

inlinevirtual

Total linear momentum of the system.

Implements kinematicCloud.

Definition at line 328 of file KinematicCloudI.H.

◆ totalParticlePerParcel()

Foam::scalar totalParticlePerParcel ( ) const

inline

Average particle per parcel.

Definition at line 343 of file KinematicCloudI.H.

◆ linearKineticEnergyOfSystem()

Foam::scalar linearKineticEnergyOfSystem ( ) const

inlinevirtual

Total linear kinetic energy in the system.

Implements kinematicCloud.

Definition at line 358 of file KinematicCloudI.H.

◆ rotationalKineticEnergyOfSystem()

scalar rotationalKineticEnergyOfSystem ( ) const

inline

Total rotational kinetic energy in the system.

◆ Dij()

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

inlinevirtual

Mean diameter Dij.

Implements kinematicCloud.

Definition at line 373 of file KinematicCloudI.H.

◆ Dmax()

Foam::scalar Dmax ( ) const

inlinevirtual

Max diameter.

Implements kinematicCloud.

Definition at line 395 of file KinematicCloudI.H.

◆ vDotSweep()

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

inlinevirtual

Volume swept rate of parcels per cell.

Implements kinematicCloud.

Definition at line 519 of file KinematicCloudI.H.

◆ theta()

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

inlinevirtual

Return the particle volume fraction field.

Note: for particles belonging to this cloud only

Implements kinematicCloud.

Definition at line 557 of file KinematicCloudI.H.

◆ alpha()

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

inlinevirtual

Return the particle mass fraction field.

Note: for particles belonging to this cloud only

Implements kinematicCloud.

Definition at line 595 of file KinematicCloudI.H.

◆ rhoEff()

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

inlinevirtual

Return the particle effective density field.

Note: for particles belonging to this cloud only

Implements kinematicCloud.

Definition at line 631 of file KinematicCloudI.H.

◆ setParcelThermoProperties()

void setParcelThermoProperties	(	parcelType &	parcel,
		const scalar	lagrangianDt
	)

Set parcel thermo properties.

Definition at line 622 of file KinematicCloud.C.

◆ checkParcelProperties()

void checkParcelProperties	(	parcelType &	parcel,
		const scalar	lagrangianDt,
		const bool	fullyDescribed
	)

Check parcel properties.

Definition at line 637 of file KinematicCloud.C.

◆ storeState()

void storeState ( )

Store the current cloud state.

Definition at line 662 of file KinematicCloud.C.

◆ restoreState()

void restoreState ( )

Reset the current cloud to the previously stored state.

Definition at line 675 of file KinematicCloud.C.

◆ resetSourceTerms()

void resetSourceTerms ( )

Reset the cloud source terms.

Definition at line 683 of file KinematicCloud.C.

◆ relax()

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

Relax field.

Definition at line 693 of file KinematicCloud.C.

◆ scale()

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

Scale field.

Definition at line 707 of file KinematicCloud.C.

◆ relaxSources()

void relaxSources ( const KinematicCloud< CloudType > & cloudOldTime )

Apply relaxation to (steady state) cloud sources.

Definition at line 719 of file KinematicCloud.C.

◆ scaleSources()

void scaleSources ( )

Apply scaling to (transient) cloud sources.

Definition at line 729 of file KinematicCloud.C.

◆ preEvolve()

void preEvolve ( const typename parcelType::trackingData & td )

Pre-evolve.

Definition at line 738 of file KinematicCloud.C.

◆ evolve()

void evolve ( )

Evolve the cloud.

Definition at line 775 of file KinematicCloud.C.

◆ motion()

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

Particle motion.

Definition at line 788 of file KinematicCloud.C.

◆ 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 808 of file KinematicCloud.C.

◆ updateMesh()

void updateMesh ( )

Update mesh.

Definition at line 849 of file KinematicCloud.C.

◆ autoMap()

void autoMap ( const mapPolyMesh & mapper )

virtual

Remap the cells of particles corresponding to the.

mesh topology change with a default tracking data object

Reimplemented from DSMCCloud< ParcelType >.

Definition at line 858 of file KinematicCloud.C.

◆ info()

void info ( )

Print cloud information.

Definition at line 867 of file KinematicCloud.C.

◆ readObjects()

void readObjects ( const objectRegistry & obr )

virtual

Read particle fields from objects in the obr registry.

Definition at line 942 of file KinematicCloud.C.

◆ writeObjects()

void writeObjects ( objectRegistry & obr ) const

virtual

Write particle fields as objects into the obr registry.

Definition at line 949 of file KinematicCloud.C.

Member Data Documentation

◆ mesh_

const fvMesh& mesh_

protected

References to the mesh and time databases.

Definition at line 160 of file KinematicCloud.H.

◆ particleProperties_

IOdictionary particleProperties_

protected

Dictionary of particle properties.

Definition at line 163 of file KinematicCloud.H.

◆ outputProperties_

IOdictionary outputProperties_

protected

Dictionary of output properties.

Definition at line 166 of file KinematicCloud.H.

◆ solution_

cloudSolution solution_

protected

Solution properties.

Definition at line 169 of file KinematicCloud.H.

◆ constProps_

parcelType::constantProperties constProps_

protected

Parcel constant properties.

Definition at line 172 of file KinematicCloud.H.

◆ subModelProperties_

const dictionary subModelProperties_

protected

Sub-models dictionary.

Definition at line 175 of file KinematicCloud.H.

◆ rndGen_

Random rndGen_

mutableprotected

Random number generator - used by some injection routines.

Definition at line 178 of file KinematicCloud.H.

◆ cellOccupancyPtr_

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

protected

Cell occupancy information for each parcel, (demand driven)

Definition at line 181 of file KinematicCloud.H.

◆ cellLengthScale_

scalarField cellLengthScale_

protected

Cell length scale.

Definition at line 184 of file KinematicCloud.H.

◆ rho_

const volScalarField& rho_

protected

Density [kg/m3].

Definition at line 190 of file KinematicCloud.H.

◆ U_

const volVectorField& U_

protected

Velocity [m/s].

Definition at line 193 of file KinematicCloud.H.

◆ mu_

const volScalarField& mu_

protected

Dynamic viscosity [Pa.s].

Definition at line 196 of file KinematicCloud.H.

◆ g_

const dimensionedVector& g_

protected

Gravity.

Definition at line 202 of file KinematicCloud.H.

◆ pAmbient_

scalar pAmbient_

protected

Averaged ambient domain pressure.

Definition at line 205 of file KinematicCloud.H.

◆ forces_

forceType forces_

protected

Optional particle forces.

Definition at line 209 of file KinematicCloud.H.

◆ functions_

functionType functions_

protected

Optional cloud function objects.

Definition at line 212 of file KinematicCloud.H.

◆ injectors_

InjectionModelList<KinematicCloud<CloudType> > injectors_

protected

Injector models.

Definition at line 218 of file KinematicCloud.H.

◆ dispersionModel_

autoPtr<DispersionModel<KinematicCloud<CloudType> > > dispersionModel_

protected

Dispersion model.

Definition at line 222 of file KinematicCloud.H.

◆ patchInteractionModel_

autoPtr<PatchInteractionModel<KinematicCloud<CloudType> > > patchInteractionModel_

protected

Patch interaction model.

Definition at line 226 of file KinematicCloud.H.

◆ stochasticCollisionModel_

autoPtr<StochasticCollisionModel<KinematicCloud<CloudType> > > stochasticCollisionModel_

protected

Stochastic collision model.

Definition at line 230 of file KinematicCloud.H.

◆ surfaceFilmModel_

autoPtr<SurfaceFilmModel<KinematicCloud<CloudType> > > surfaceFilmModel_

protected

Surface film model.

Definition at line 234 of file KinematicCloud.H.

◆ packingModel_

autoPtr<PackingModel<KinematicCloud<CloudType> > > packingModel_

protected

Packing model.

Definition at line 238 of file KinematicCloud.H.

◆ dampingModel_

autoPtr<DampingModel<KinematicCloud<CloudType> > > dampingModel_

protected

Damping model.

Definition at line 242 of file KinematicCloud.H.

◆ isotropyModel_

autoPtr<IsotropyModel<KinematicCloud<CloudType> > > isotropyModel_

protected

Exchange model.

Definition at line 246 of file KinematicCloud.H.

◆ UIntegrator_

autoPtr<integrationScheme> UIntegrator_

protected

Velocity integration.

Definition at line 252 of file KinematicCloud.H.

◆ UTrans_

autoPtr<volVectorField::Internal> UTrans_

protected

Momentum.

Definition at line 258 of file KinematicCloud.H.

◆ UCoeff_

autoPtr<volScalarField::Internal> UCoeff_

protected

Coefficient for carrier phase U equation.

Definition at line 261 of file KinematicCloud.H.

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

src/lagrangian/intermediate/clouds/Templates/KinematicCloud/KinematicCloud.H
src/lagrangian/intermediate/clouds/Templates/KinematicCloud/KinematicCloud.C
src/lagrangian/intermediate/clouds/Templates/KinematicCloud/KinematicCloudI.H

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class CloudType> class Foam::KinematicCloud< CloudType >

Member Typedef Documentation

◆ cloudType

◆ parcelType

◆ kinematicCloudType

◆ forceType

◆ functionType

Constructor & Destructor Documentation

◆ KinematicCloud() [1/3]

◆ KinematicCloud() [2/3]

◆ KinematicCloud() [3/3]

◆ ~KinematicCloud()

Member Function Documentation

◆ setModels()

◆ solve()

◆ buildCellOccupancy()

◆ updateCellOccupancy()

◆ evolveCloud()

◆ postEvolve()

◆ cloudReset()

◆ clone()

◆ cloneBare()

◆ cloudCopy()

◆ mesh()

◆ particleProperties()

◆ outputProperties() [1/2]

◆ outputProperties() [2/2]

◆ solution() [1/2]

◆ solution() [2/2]

◆ constProps() [1/2]

◆ constProps() [2/2]

◆ subModelProperties()

◆ rndGen()

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

◆ packingModel() [1/2]

◆ packingModel() [2/2]

◆ dampingModel() [1/2]

◆ dampingModel() [2/2]

◆ isotropyModel() [1/2]

◆ isotropyModel() [2/2]

◆ UIntegrator()

◆ UTrans() [1/2]

◆ UTrans() [2/2]

◆ UCoeff() [1/2]

◆ UCoeff() [2/2]

◆ SU()

◆ nParcels()

◆ massInSystem()

◆ linearMomentumOfSystem()

◆ totalParticlePerParcel()

◆ linearKineticEnergyOfSystem()

◆ rotationalKineticEnergyOfSystem()

◆ Dij()

◆ Dmax()

template<class CloudType>
class Foam::KinematicCloud< CloudType >