Collision model by P.J. O'Rourke. More...

#include <ORourkeCollision.H>

Inheritance diagram for ORourkeCollision< CloudType >:

[legend]

Collaboration diagram for ORourkeCollision< CloudType >:

[legend]

Public Member Functions
	TypeName ("ORourke")
	Runtime type information.
	ORourkeCollision (const dictionary &dict, CloudType &cloud, const word &modelName=typeName)
	Construct from dictionary.
	ORourkeCollision (const ORourkeCollision< CloudType > &cm)
	Construct copy.
virtual autoPtr< StochasticCollisionModel< CloudType > >	clone () const
	Construct and return a clone.
virtual	~ORourkeCollision ()
	Destructor.
Public Member Functions inherited from StochasticCollisionModel< CloudType >
	TypeName ("collisionModel")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, StochasticCollisionModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
	Declare runtime constructor selection table.
	StochasticCollisionModel (CloudType &owner)
	Construct null from owner.
	StochasticCollisionModel (const dictionary &dict, CloudType &owner, const word &type)
	Construct from dictionary.
	StochasticCollisionModel (const StochasticCollisionModel< CloudType > &cm)
	Construct copy.
virtual	~StochasticCollisionModel ()
	Destructor.
void	update (typename CloudType::parcelType::trackingData &td, const scalar dt)
	Update the model.
Public Member Functions inherited from CloudSubModelBase< CloudType >
	CloudSubModelBase (CloudType &owner)
	Construct null from owner cloud.
	CloudSubModelBase (CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from owner cloud without name.
	CloudSubModelBase (const word &modelName, CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from owner cloud with name.
	CloudSubModelBase (const CloudSubModelBase< CloudType > &smb)
	Construct as copy.
virtual	~CloudSubModelBase ()=default
	Destructor.
const CloudType &	owner () const
	Return const access to the owner cloud.
virtual bool	writeTime () const
	Flag to indicate when to write a property.
virtual fileName	localPath () const
	Output directory.
CloudType &	owner ()
	Return non-const access to the owner cloud for manipulation.
virtual void	info ()
	Write to info.
virtual void	write (Ostream &os) const
	Write to os.
Public Member Functions inherited from subModelBase
	subModelBase (dictionary &properties)
	Construct null.
	subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from components without name.
	subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from components with name.
	subModelBase (const subModelBase &smb)
	Construct as copy.
virtual	~subModelBase ()=default
	Destructor.
const word &	modelName () const
	Return const access to the name of the sub-model.
const dictionary &	dict () const
	Return const access to the cloud dictionary.
const word &	baseName () const
	Return const access to the base name of the sub-model.
const word &	modelType () const
	Return const access to the sub-model type.
const dictionary &	coeffDict () const
	Return const access to the coefficients dictionary.
const dictionary &	properties () const
	Return const access to the properties dictionary.
virtual bool	defaultCoeffs (const bool printMsg) const
	Returns true if defaultCoeffs is true and outputs on printMsg.
virtual bool	active () const
	Return the model 'active' status - default active = true.
virtual void	cacheFields (const bool store)
	Cache dependent sub-model fields.
template<class Type>
Type	getBaseProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from the base model.
template<class Type>
void	getBaseProperty (const word &entryName, Type &value) const
	Retrieve generic property from the base model.
template<class Type>
void	setBaseProperty (const word &entryName, const Type &value)
	Add generic property to the base model.
bool	getModelDict (const word &entryName, dictionary &dict) const
	Retrieve dictionary, return true if set.
template<class Type>
bool	getModelProperty (const word &entryName, Type &value) const
	Retrieve generic property from the sub-model.
template<class Type>
Type	getModelProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from the sub-model.
template<class Type>
void	setModelProperty (const word &entryName, const Type &value)
	Add generic property to the sub-model.

Protected Types
typedef CloudType::parcelType	parcelType
	Convenience typedef to the cloud's parcel type.

Protected Member Functions
virtual void	collide (typename CloudType::parcelType::trackingData &td, const scalar dt)
	Main collision routine.
virtual bool	collideParcels (const scalar dt, parcelType &p1, parcelType &p2, scalar &m1, scalar &m2)
	Collide parcels and return true if mass has changed.
virtual bool	collideSorted (const scalar dt, parcelType &p1, parcelType &p2, scalar &m1, scalar &m2)
Protected Member Functions inherited from subModelBase
bool	inLine () const
	Flag to indicate whether data is/was read in-line.

Protected Attributes
const liquidMixtureProperties &	liquids_
bool	coalescence_
	Coalescence activated?
Protected Attributes inherited from CloudSubModelBase< CloudType >
CloudType &	owner_
	Reference to the cloud.
Protected Attributes inherited from subModelBase
const word	modelName_
	Name of the sub-model.
dictionary &	properties_
	Reference to properties dictionary e.g. for restart.
const dictionary	dict_
	Copy of dictionary used during construction.
const word	baseName_
	Name of the sub-model base class.
const word	modelType_
	Type of the sub-model.
const dictionary	coeffDict_
	Coefficients dictionary.

Additional Inherited Members
Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType	cloudType
	Type of cloud this model was instantiated for.
Static Public Member Functions inherited from StochasticCollisionModel< CloudType >
static autoPtr< StochasticCollisionModel< CloudType > >	New (const dictionary &dict, CloudType &owner)
	Selector.
Public Attributes inherited from subModelBase
bool	log
	Flag to write log into Info.

Detailed Description

template<class CloudType>
class Foam::ORourkeCollision< CloudType >

Collision model by P.J. O'Rourke.

Definition at line 43 of file ORourkeCollision.H.

Member Typedef Documentation

◆ parcelType

template<class CloudType>

typedef CloudType::parcelType parcelType

protected

Convenience typedef to the cloud's parcel type.

Definition at line 54 of file ORourkeCollision.H.

Constructor & Destructor Documentation

◆ ORourkeCollision() [1/2]

template<class CloudType>

ORourkeCollision	(	const dictionary &	dict,
		CloudType &	cloud,
		const word &	modelName = typeName )

Construct from dictionary.

Definition at line 285 of file ORourkeCollision.C.

References coalescence_, subModelBase::coeffDict(), subModelBase::dict(), liquids_, subModelBase::modelName(), CloudSubModelBase< CloudType >::owner(), and StochasticCollisionModel< CloudType >::StochasticCollisionModel().

Referenced by clone(), ORourkeCollision(), TrajectoryCollision< CloudType >::TrajectoryCollision(), TrajectoryCollision< CloudType >::TrajectoryCollision(), and TypeName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ORourkeCollision() [2/2]

template<class CloudType>

ORourkeCollision ( const ORourkeCollision< CloudType > & cm )

Construct copy.

Definition at line 305 of file ORourkeCollision.C.

References coalescence_, liquids_, ORourkeCollision(), and StochasticCollisionModel< CloudType >::StochasticCollisionModel().

Here is the call graph for this function:

◆ ~ORourkeCollision()

template<class CloudType>

~ORourkeCollision ( )

virtual

Destructor.

Definition at line 319 of file ORourkeCollision.C.

Member Function Documentation

◆ collide()

template<class CloudType>

void collide	(	typename CloudType::parcelType::trackingData &	td,
		const scalar	dt )

protectedvirtual

Main collision routine.

Implements StochasticCollisionModel< CloudType >.

Reimplemented in TrajectoryCollision< CloudType >.

Definition at line 32 of file ORourkeCollision.C.

References Foam::cbrt(), collideParcels(), forAll, liquids_, mesh, CloudSubModelBase< CloudType >::owner(), p, Foam::constant::mathematical::pi(), UList< T >::size(), td(), and Foam::Zero.

Referenced by TrajectoryCollision< CloudType >::collide().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ collideParcels()

template<class CloudType>

bool collideParcels	(	const scalar	dt,
		parcelType &	p1,
		parcelType &	p2,
		scalar &	m1,
		scalar &	m2 )

protectedvirtual

Collide parcels and return true if mass has changed.

Reimplemented in TrajectoryCollision< CloudType >.

Definition at line 118 of file ORourkeCollision.C.

References particle< Type >::cell(), collideSorted(), Foam::exp(), Foam::mag(), Foam::min(), nu, CloudSubModelBase< CloudType >::owner(), Foam::constant::mathematical::pi(), Foam::sqr(), and DSMCParcel< ParcelType >::U().

Referenced by collide().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ collideSorted()

template<class CloudType>

bool collideSorted	(	const scalar	dt,
		parcelType &	p1,
		parcelType &	p2,
		scalar &	m1,
		scalar &	m2 )

protectedvirtual

Definition at line 163 of file ORourkeCollision.C.

References coalescence_, f(), gamma, Foam::mag(), Foam::max(), Foam::min(), mTot, CloudSubModelBase< CloudType >::owner(), Foam::pow3(), rho1, rho2, Foam::sqr(), Foam::sqrt(), DSMCParcel< ParcelType >::U(), U1, and U2.

Referenced by collideParcels(), and TrajectoryCollision< CloudType >::collideParcels().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

template<class CloudType>

TypeName ( "ORourke" )

Runtime type information.

References subModelBase::dict(), Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, subModelBase::modelName(), and ORourkeCollision().

Here is the call graph for this function:

◆ clone()

template<class CloudType>

virtual autoPtr< StochasticCollisionModel< CloudType > > clone ( ) const

inlinevirtual

Construct and return a clone.

Implements StochasticCollisionModel< CloudType >.

Reimplemented in TrajectoryCollision< CloudType >.

Definition at line 126 of file ORourkeCollision.H.

References ORourkeCollision().

Here is the call graph for this function:

Member Data Documentation

◆ liquids_

template<class CloudType>

const liquidMixtureProperties& liquids_

protected

Definition at line 56 of file ORourkeCollision.H.

Referenced by collide(), ORourkeCollision(), and ORourkeCollision().

◆ coalescence_

template<class CloudType>

bool coalescence_

protected

Coalescence activated?

Definition at line 61 of file ORourkeCollision.H.

Referenced by collideSorted(), ORourkeCollision(), and ORourkeCollision().

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

src/lagrangian/spray/submodels/StochasticCollision/ORourkeCollision/ORourkeCollision.H
src/lagrangian/spray/submodels/StochasticCollision/ORourkeCollision/ORourkeCollision.C

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ parcelType

Constructor & Destructor Documentation

◆ ORourkeCollision() [1/2]

◆ ORourkeCollision() [2/2]

◆ ~ORourkeCollision()

Member Function Documentation

◆ collide()

◆ collideParcels()

◆ collideSorted()

◆ TypeName()

◆ clone()

Member Data Documentation

◆ liquids_

◆ coalescence_