Templated base class for kinematic cloud. More...

Inheritance diagram for KinematicCloud< CloudType >:

Collaboration diagram for KinematicCloud< CloudType >:

[legend]

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

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

typedef 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< ParcelType >
typedef ParticleType	particleType

typedef IDLList< ParticleType >::iterator	iterator

typedef IDLList< ParticleType >::const_iterator	const_iterator

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 ()
	Destructor. More...

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

virtual bool	hasWallImpactDistance () const
	Switch to specify if particles of the cloud can return. 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...

cachedRandom &	rndGen ()
	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 vectorIntegrationScheme &	UIntegrator () const
	Return reference to velocity integration. More...

DimensionedField< vector, volMesh > &	UTrans ()
	Return reference to momentum source. More...

const DimensionedField< vector, volMesh > &	UTrans () const
	Return const reference to momentum source. More...

DimensionedField< scalar, volMesh > &	UCoeff ()
	Return coefficient for carrier phase U equation. More...

const DimensionedField< scalar, volMesh > &	UCoeff () const
	Return const coefficient for carrier phase U equation. More...

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

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

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

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

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

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

scalar	penetration (const scalar fraction) const
	Penetration for fraction [0-1] of the current total mass. 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 ()
	Pre-evolve. More...

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

template<class TrackData >
void	motion (TrackData &td)
	Particle motion. More...

void	patchData (const parcelType &p, const polyPatch &pp, const scalar trackFraction, const tetIndices &tetIs, 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...

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 refernce 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 refernce to the random object. More...

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

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

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

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

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

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

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

volVectorField::GeometricBoundaryField &	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 vector &U, const scalar Ei, const label cellI, const label tetFaceI, const label tetPtI, 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< ParcelType >
	TypeName ("Cloud")
	Runtime type information. More...

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

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

	Cloud (const polyMesh &mesh, const bool checkClass=true)
	Construct from mesh by reading from file. 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

DynamicList< label > &	labels ()

label	nTrackingRescues () const
	Return nTrackingRescues. More...

void	trackingRescue () const
	Increment the nTrackingRescues counter. More...

const PackedBoolList &	cellHasWallFaces () const
	Whether each cell has any wall faces (demand driven data) More...

virtual bool	hasWallImpactDistance () const
	Switch to specify if particles of the cloud can return. 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 (ParticleType *pPtr)
	Transfer particle to cloud. More...

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

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

void	move (TrackData &td, const scalar trackTime)
	Move the particles. More...

void	autoMap (TrackData &td, 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...

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

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

virtual void	readFields ()
	Read the field data for the cloud of particles. Dummy at. 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
	Write using given format, version and compression. More...

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

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

	DSMCBaseCloud ()
	Null constructor. More...

virtual	~DSMCBaseCloud ()
	Destructor. More...

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

	kinematicCloud ()
	Null constructor. More...

virtual	~kinematicCloud ()
	Destructor. More...

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

template<class TrackData >
void	solve (TrackData &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 TrackData >
void	evolveCloud (TrackData &td)
	Evolve the cloud. More...

void	postEvolve ()
	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...

cachedRandom	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< vectorIntegrationScheme >	UIntegrator_
	Velocity integration. More...

autoPtr< DimensionedField< vector, volMesh > >	UTrans_
	Momentum. More...

autoPtr< DimensionedField< scalar, volMesh > >	UCoeff_
	Coefficient for carrier phase U equation. More...

Private Member Functions
	KinematicCloud (const KinematicCloud &)
	Disallow default bitwise copy construct. More...

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

Private Attributes
autoPtr< KinematicCloud< CloudType > >	cloudCopyPtr_
	Cloud copy pointer. More...

Additional Inherited Members
Static Public Attributes inherited from Cloud< ParcelType >
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 96 of file KinematicCloud.H.

Member Typedef Documentation

◆ cloudType

typedef CloudType cloudType

Type of cloud this cloud was instantiated for.

Definition at line 106 of file KinematicCloud.H.

◆ parcelType

typedef CloudType::particleType parcelType

Type of parcel the cloud was instantiated for.

Definition at line 109 of file KinematicCloud.H.

◆ kinematicCloudType

typedef KinematicCloud<CloudType> kinematicCloudType

Convenience typedef for this cloud type.

Definition at line 112 of file KinematicCloud.H.

◆ forceType

typedef ParticleForceList<KinematicCloud<CloudType> > forceType

Force models type.

Definition at line 115 of file KinematicCloud.H.

◆ functionType

typedef CloudFunctionObjectList<KinematicCloud<CloudType> > functionType

Function object type.

Definition at line 119 of file KinematicCloud.H.

Constructor & Destructor Documentation

◆ KinematicCloud() [1/4]

KinematicCloud ( const KinematicCloud< CloudType > & )

private

Disallow default bitwise copy construct.

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

Here is the caller graph for this function:

◆ KinematicCloud() [2/4]

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

Construct given carrier gas fields.

Definition at line 274 of file KinematicCloud.C.

References readFields().

Here is the call graph for this function:

◆ KinematicCloud() [3/4]

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

Copy constructor with new name.

Definition at line 409 of file KinematicCloud.C.

◆ KinematicCloud() [4/4]

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

Copy constructor with new name - creates bare cloud.

Definition at line 476 of file KinematicCloud.C.

◆ ~KinematicCloud()

~KinematicCloud

virtual

Destructor.

Definition at line 538 of file KinematicCloud.C.

Member Function Documentation

◆ operator=()

void operator= ( const KinematicCloud< CloudType > & )

private

Disallow default bitwise assignment.

◆ setModels()

void setModels

protected

Set cloud sub-models.

Definition at line 40 of file KinematicCloud.C.

References Foam::compressible::New().

Here is the call graph for this function:

◆ solve()

void solve ( TrackData & td )

protected

Solve the cloud - calls all evolution functions.

Definition at line 91 of file KinematicCloud.C.

◆ buildCellOccupancy()

void buildCellOccupancy

protected

Build the cellOccupancy.

Definition at line 130 of file KinematicCloud.C.

References cellOccupancy, forAll, and forAllIter.

◆ updateCellOccupancy()

void updateCellOccupancy

protected

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

already been used

Definition at line 162 of file KinematicCloud.C.

◆ evolveCloud()

void evolveCloud ( TrackData & td )

protected

Evolve the cloud.

Definition at line 176 of file KinematicCloud.C.

References surfaceFilm.

◆ postEvolve()

void postEvolve

protected

Post-evolve.

Definition at line 219 of file KinematicCloud.C.

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

Here is the call graph for this function:

◆ cloudReset()

void cloudReset ( KinematicCloud< CloudType > & c )

protected

Reset state of cloud.

Definition at line 249 of file KinematicCloud.C.

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

◆ clone()

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

inlinevirtual

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

Definition at line 297 of file KinematicCloud.H.

References KinematicCloud< CloudType >::KinematicCloud(), and Foam::name().

Here is the call graph for this function:

◆ cloneBare()

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

inlinevirtual

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

Definition at line 306 of file KinematicCloud.H.

References KinematicCloud< CloudType >::KinematicCloud(), and KinematicCloud< CloudType >::mesh().

Here is the call graph for this function:

◆ cloudCopy()

const Foam::KinematicCloud< CloudType > & cloudCopy

inline

Return a reference to the cloud copy.

Definition at line 33 of file KinematicCloudI.H.

◆ hasWallImpactDistance()

bool hasWallImpactDistance

virtual

Switch to specify if particles of the cloud can return.

non-zero wall distance values - true for kinematic parcels

Definition at line 545 of file KinematicCloud.C.

◆ mesh()

const Foam::fvMesh & mesh

inline

Return reference to the mesh.

Definition at line 40 of file KinematicCloudI.H.

Referenced by KinematicCloud< CloudType >::cloneBare().

Here is the caller graph for this function:

◆ particleProperties()

const Foam::IOdictionary & particleProperties

inline

Return particle properties dictionary.

Definition at line 48 of file KinematicCloudI.H.

◆ outputProperties() [1/2]

Foam::IOdictionary & outputProperties

inline

Return output properties dictionary.

Definition at line 56 of file KinematicCloudI.H.

◆ outputProperties() [2/2]

IOdictionary& outputProperties ( )

inline

Return non-const access to the output properties dictionary.

◆ solution() [1/2]

Foam::cloudSolution & solution

inline

Return const access to the solution properties.

Definition at line 71 of file KinematicCloudI.H.

◆ solution() [2/2]

cloudSolution& solution ( )

inline

Return access to the solution properties.

◆ constProps() [1/2]

CloudType::particleType::constantProperties & constProps

inline

Return the constant properties.

Definition at line 86 of file KinematicCloudI.H.

◆ constProps() [2/2]

parcelType::constantProperties& constProps ( )

inline

Return access to the constant properties.

◆ subModelProperties()

const Foam::dictionary & subModelProperties

inline

Return reference to the sub-models dictionary.

Definition at line 102 of file KinematicCloudI.H.

◆ rndGen()

Foam::cachedRandom & rndGen

inline

Return reference to the random object.

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

◆ cellLengthScale()

const Foam::scalarField & cellLengthScale

inline

Return the cell length scale.

Definition at line 516 of file KinematicCloudI.H.

◆ U()

const Foam::volVectorField & U

inline

Return carrier gas velocity.

Definition at line 116 of file KinematicCloudI.H.

◆ rho()

const Foam::volScalarField & rho

inline

Return carrier gas density.

Definition at line 109 of file KinematicCloudI.H.

◆ mu()

const Foam::volScalarField & mu

inline

Return carrier gas dynamic viscosity.

Definition at line 123 of file KinematicCloudI.H.

◆ g()

const Foam::dimensionedVector & g

inline

Gravity.

Definition at line 130 of file KinematicCloudI.H.

◆ pAmbient() [1/2]

Foam::scalar & pAmbient

inline

Return const-access to the ambient pressure.

Definition at line 137 of file KinematicCloudI.H.

◆ pAmbient() [2/2]

scalar& pAmbient ( )

inline

Return reference to the ambient pressure.

◆ forces() [1/2]

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

inline

Optional particle forces.

inline const typename parcelType::forceType& forces() const;

Definition at line 153 of file KinematicCloudI.H.

◆ forces() [2/2]

forceType& forces ( )

inline

Return the optional particle forces.

◆ functions()

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

inline

Optional cloud function objects.

Definition at line 169 of file KinematicCloudI.H.

◆ injectors() [1/2]

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

inline

Return const access to the injection model.

Definition at line 177 of file KinematicCloudI.H.

◆ injectors() [2/2]

InjectionModelList<KinematicCloud<CloudType> >& injectors ( )

inline

Return reference to the injection model.

◆ dispersion() [1/2]

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

inline

Return const-access to the dispersion model.

Definition at line 193 of file KinematicCloudI.H.

◆ dispersion() [2/2]

DispersionModel<KinematicCloud<CloudType> >& dispersion ( )

inline

Return reference to the dispersion model.

◆ patchInteraction() [1/2]

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

inline

Return const-access to the patch interaction model.

Definition at line 209 of file KinematicCloudI.H.

◆ patchInteraction() [2/2]

PatchInteractionModel<KinematicCloud<CloudType> >& patchInteraction ( )

inline

Return reference to the patch interaction model.

◆ stochasticCollision() [1/2]

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

inline

Return const-access to the stochastic collision model.

Definition at line 225 of file KinematicCloudI.H.

◆ stochasticCollision() [2/2]

StochasticCollisionModel<KinematicCloud<CloudType> >& stochasticCollision ( )

inline

Return reference to the stochastic collision model.

◆ surfaceFilm() [1/2]

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

inline

Return const-access to the surface film model.

Definition at line 241 of file KinematicCloudI.H.

◆ surfaceFilm() [2/2]

SurfaceFilmModel<KinematicCloud<CloudType> >& surfaceFilm ( )

inline

Return reference to the surface film model.

◆ UIntegrator()

const Foam::vectorIntegrationScheme & UIntegrator

inline

Return reference to velocity integration.

Definition at line 257 of file KinematicCloudI.H.

◆ UTrans() [1/2]

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

inline

Return reference to momentum source.

Definition at line 524 of file KinematicCloudI.H.

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

Here is the caller graph for this function:

◆ UTrans() [2/2]

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

inline

Return const reference to momentum source.

◆ UCoeff() [1/2]

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

inline

Return coefficient for carrier phase U equation.

Definition at line 540 of file KinematicCloudI.H.

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

Here is the caller graph for this function:

◆ UCoeff() [2/2]

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

inline

Return const coefficient for carrier phase U equation.

◆ SU()

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

inline

Return tmp momentum source term.

Definition at line 556 of file KinematicCloudI.H.

References Foam::dimForce, Foam::endl(), Foam::Info, Foam::max(), Foam::min(), Foam::nl, fvMatrix::source(), Foam::fvc::Sp(), U, and dimensioned::value().

Here is the call graph for this function:

◆ nParcels()

Foam::label nParcels

inlinevirtual

Total number of parcels.

Implements kinematicCloud.

Definition at line 264 of file KinematicCloudI.H.

◆ massInSystem()

Foam::scalar massInSystem

inlinevirtual

Total mass in system.

Implements kinematicCloud.

Definition at line 271 of file KinematicCloudI.H.

References forAllConstIter(), and p.

Here is the call graph for this function:

◆ linearMomentumOfSystem()

Foam::vector linearMomentumOfSystem

inlinevirtual

Total linear momentum of the system.

Implements kinematicCloud.

Definition at line 286 of file KinematicCloudI.H.

References forAllConstIter(), and p.

Here is the call graph for this function:

◆ linearKineticEnergyOfSystem()

Foam::scalar linearKineticEnergyOfSystem

inlinevirtual

Total linear kinetic energy in the system.

Implements kinematicCloud.

Definition at line 303 of file KinematicCloudI.H.

References forAllConstIter(), and p.

Here is the call graph for this function:

◆ rotationalKineticEnergyOfSystem()

scalar rotationalKineticEnergyOfSystem ( ) const

inline

Total rotational kinetic energy in the system.

◆ penetration()

Foam::scalar penetration ( const scalar fraction ) const

inline

Penetration for fraction [0-1] of the current total mass.

Definition at line 360 of file KinematicCloudI.H.

References Foam::constant::atomic::alpha, UList::assign(), Foam::distance(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAllConstIter(), forAllReverse, SortableList::indices(), globalIndex::localSize(), Foam::mag(), globalIndex::offset(), p, Foam::reduce(), List::setSize(), List::size(), globalIndex::size(), and SortableList::sort().

Here is the call graph for this function:

◆ Dij()

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

inlinevirtual

Mean diameter Dij.

Implements kinematicCloud.

Definition at line 320 of file KinematicCloudI.H.

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

Here is the call graph for this function:

◆ Dmax()

Foam::scalar Dmax

inlinevirtual

Max diameter.

Implements kinematicCloud.

Definition at line 343 of file KinematicCloudI.H.

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

Here is the call graph for this function:

◆ vDotSweep()

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

inlinevirtual

Volume swept rate of parcels per cell.

Implements kinematicCloud.

Definition at line 592 of file KinematicCloudI.H.

References GeometricField::correctBoundaryConditions(), Foam::dimless, Foam::dimTime, forAllConstIter(), GeometricField::internalField(), Foam::mag(), Foam::name(), p, and timeName.

Here is the call graph for this function:

◆ theta()

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

inlinevirtual

Return the particle volume fraction field.

Note: for particles belonging to this cloud only

Implements kinematicCloud.

Definition at line 631 of file KinematicCloudI.H.

References GeometricField::correctBoundaryConditions(), Foam::dimless, forAllConstIter(), GeometricField::internalField(), Foam::name(), p, and timeName.

Here is the call graph for this function:

◆ alpha()

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

inlinevirtual

Return the particle mass fraction field.

Note: for particles belonging to this cloud only

Implements kinematicCloud.

Definition at line 670 of file KinematicCloudI.H.

References Foam::constant::atomic::alpha, Foam::dimless, forAllConstIter(), Foam::name(), p, and timeName.

Here is the call graph for this function:

◆ rhoEff()

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

inlinevirtual

Return the particle effective density field.

Note: for particles belonging to this cloud only

Implements kinematicCloud.

Definition at line 707 of file KinematicCloudI.H.

References Foam::dimDensity, forAllConstIter(), Foam::name(), p, and timeName.

Here is the call graph for this function:

◆ setParcelThermoProperties()

void setParcelThermoProperties	(	parcelType &	parcel,
		const scalar	lagrangianDt
	)

Set parcel thermo properties.

Definition at line 553 of file KinematicCloud.C.

◆ checkParcelProperties()

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

Check parcel properties.

Definition at line 564 of file KinematicCloud.C.

◆ storeState()

void storeState

Store the current cloud state.

Definition at line 581 of file KinematicCloud.C.

References Foam::name().

Here is the call graph for this function:

◆ restoreState()

void restoreState

Reset the current cloud to the previously stored state.

Definition at line 594 of file KinematicCloud.C.

◆ resetSourceTerms()

void resetSourceTerms

Reset the cloud source terms.

Definition at line 602 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 612 of file KinematicCloud.C.

References coeff, and Foam::name().

Here is the call graph for this function:

◆ scale()

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

Scale field.

Definition at line 626 of file KinematicCloud.C.

References coeff, and Foam::name().

Here is the call graph for this function:

◆ relaxSources()

void relaxSources ( const KinematicCloud< CloudType > & cloudOldTime )

Apply relaxation to (steady state) cloud sources.

Definition at line 638 of file KinematicCloud.C.

References relax(), KinematicCloud< CloudType >::UCoeff(), and KinematicCloud< CloudType >::UTrans().

Here is the call graph for this function:

◆ scaleSources()

void scaleSources

Apply scaling to (transient) cloud sources.

Definition at line 648 of file KinematicCloud.C.

◆ preEvolve()

void preEvolve

Pre-evolve.

Definition at line 656 of file KinematicCloud.C.

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

Here is the call graph for this function:

◆ evolve()

void evolve

Evolve the cloud.

Definition at line 676 of file KinematicCloud.C.

References solve().

Here is the call graph for this function:

◆ motion()

void motion ( TrackData & td )

Particle motion.

Definition at line 690 of file KinematicCloud.C.

◆ patchData()

void patchData	(	const parcelType &	p,
		const polyPatch &	pp,
		const scalar	trackFraction,
		const tetIndices &	tetIs,
		vector &	normal,
		vector &	Up
	)		const

Calculate the patch normal and velocity to interact with,.

accounting for patch motion if required.

Definition at line 701 of file KinematicCloud.C.

References Foam::asin(), Vector< Cmpt >::centre(), tetIndices::faceTri(), patchIdentifier::index(), Foam::mag(), n, triangle::normal(), nw, tetIndices::oldFaceTri(), p, U, and polyPatch::whichFace().

Here is the call graph for this function:

◆ updateMesh()

void updateMesh

Update mesh.

Definition at line 846 of file KinematicCloud.C.

References Foam::cbrt().

Here is the call graph for this function:

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

◆ info()

void info

Print cloud information.

Definition at line 868 of file KinematicCloud.C.

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

Here is the call graph for this function:

Field Documentation

◆ cloudCopyPtr_

autoPtr<KinematicCloud<CloudType> > cloudCopyPtr_

private

Cloud copy pointer.

Definition at line 127 of file KinematicCloud.H.

◆ mesh_

const fvMesh& mesh_

protected

References to the mesh and time databases.

Definition at line 144 of file KinematicCloud.H.

◆ particleProperties_

IOdictionary particleProperties_

protected

Dictionary of particle properties.

Definition at line 147 of file KinematicCloud.H.

◆ outputProperties_

IOdictionary outputProperties_

protected

Dictionary of output properties.

Definition at line 150 of file KinematicCloud.H.

◆ solution_

cloudSolution solution_

protected

Solution properties.

Definition at line 153 of file KinematicCloud.H.

◆ constProps_

parcelType::constantProperties constProps_

protected

Parcel constant properties.

Definition at line 156 of file KinematicCloud.H.

◆ subModelProperties_

const dictionary subModelProperties_

protected

Sub-models dictionary.

Definition at line 159 of file KinematicCloud.H.

◆ rndGen_

cachedRandom rndGen_

protected

Random number generator - used by some injection routines.

Definition at line 162 of file KinematicCloud.H.

◆ cellOccupancyPtr_

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

protected

Cell occupancy information for each parcel, (demand driven)

Definition at line 165 of file KinematicCloud.H.

◆ cellLengthScale_

scalarField cellLengthScale_

protected

Cell length scale.

Definition at line 168 of file KinematicCloud.H.

◆ rho_

const volScalarField& rho_

protected

Density [kg/m3].

Definition at line 174 of file KinematicCloud.H.

◆ U_

const volVectorField& U_

protected

Velocity [m/s].

Definition at line 177 of file KinematicCloud.H.

◆ mu_

const volScalarField& mu_

protected

Dynamic viscosity [Pa.s].

Definition at line 180 of file KinematicCloud.H.

◆ g_

const dimensionedVector& g_

protected

Gravity.

Definition at line 186 of file KinematicCloud.H.

◆ pAmbient_

scalar pAmbient_

protected

Averaged ambient domain pressure.

Definition at line 189 of file KinematicCloud.H.

◆ forces_

forceType forces_

protected

Optional particle forces.

Definition at line 193 of file KinematicCloud.H.

◆ functions_

functionType functions_

protected

Optional cloud function objects.

Definition at line 196 of file KinematicCloud.H.

◆ injectors_

InjectionModelList<KinematicCloud<CloudType> > injectors_

protected

Injector models.

Definition at line 202 of file KinematicCloud.H.

◆ dispersionModel_

autoPtr<DispersionModel<KinematicCloud<CloudType> > > dispersionModel_

protected

Dispersion model.

Definition at line 206 of file KinematicCloud.H.

◆ patchInteractionModel_

autoPtr<PatchInteractionModel<KinematicCloud<CloudType> > > patchInteractionModel_

protected

Patch interaction model.

Definition at line 210 of file KinematicCloud.H.

◆ stochasticCollisionModel_

autoPtr<StochasticCollisionModel<KinematicCloud<CloudType> > > stochasticCollisionModel_

protected

Stochastic collision model.

Definition at line 214 of file KinematicCloud.H.

◆ surfaceFilmModel_

autoPtr<SurfaceFilmModel<KinematicCloud<CloudType> > > surfaceFilmModel_

protected

Surface film model.

Definition at line 218 of file KinematicCloud.H.

◆ UIntegrator_

autoPtr<vectorIntegrationScheme> UIntegrator_

protected

Velocity integration.

Definition at line 224 of file KinematicCloud.H.

◆ UTrans_

autoPtr<DimensionedField<vector, volMesh> > UTrans_

protected

Momentum.

Definition at line 230 of file KinematicCloud.H.

◆ UCoeff_

autoPtr<DimensionedField<scalar, volMesh> > UCoeff_

protected

Coefficient for carrier phase U equation.

Definition at line 233 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

Private Member Functions

Private 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/4]

◆ KinematicCloud() [2/4]

◆ KinematicCloud() [3/4]

◆ KinematicCloud() [4/4]

◆ ~KinematicCloud()

Member Function Documentation

◆ operator=()

◆ setModels()

◆ solve()

◆ buildCellOccupancy()

◆ updateCellOccupancy()

◆ evolveCloud()

◆ postEvolve()

◆ cloudReset()

◆ clone()

◆ cloneBare()

◆ cloudCopy()

◆ hasWallImpactDistance()

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

◆ UIntegrator()

◆ UTrans() [1/2]

◆ UTrans() [2/2]

◆ UCoeff() [1/2]

◆ UCoeff() [2/2]

◆ SU()

◆ nParcels()

◆ massInSystem()

◆ linearMomentumOfSystem()

◆ linearKineticEnergyOfSystem()

◆ rotationalKineticEnergyOfSystem()

◆ penetration()

◆ Dij()

◆ Dmax()

◆ vDotSweep()

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