Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
ORourkeCollision< CloudType > Class Template Reference

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

Inheritance diagram for ORourkeCollision< CloudType >:
Inheritance graph
[legend]
Collaboration diagram for ORourkeCollision< CloudType >:
Collaboration graph
[legend]

Public Member Functions

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

Protected Types

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

Protected Member Functions

virtual void collide (const scalar dt)
 Main collision routine. More...
 
virtual bool collideParcels (const scalar dt, parcelType &p1, parcelType &p2, scalar &m1, scalar &m2)
 Collide parcels and return true if mass has changed. More...
 
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. More...
 

Protected Attributes

const liquidMixturePropertiesliquids_
 
Switch coalescence_
 Coalescence activation switch. More...
 
- Protected Attributes inherited from CloudSubModelBase< CloudType >
CloudTypeowner_
 Reference to the cloud. More...
 
- Protected Attributes inherited from subModelBase
const word modelName_
 Name of the sub-model. More...
 
dictionaryproperties_
 Reference to properties dictionary e.g. for restart. More...
 
const dictionary dict_
 Copy of dictionary used during construction. More...
 
const word baseName_
 Name of the sub-model base class. More...
 
const word modelType_
 Type of the sub-model. More...
 
const dictionary coeffDict_
 Coefficients dictionary. More...
 

Additional Inherited Members

- Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType cloudType
 Type of cloud this model was instantiated for. More...
 
- Static Public Member Functions inherited from StochasticCollisionModel< CloudType >
static autoPtr< StochasticCollisionModel< CloudType > > New (const dictionary &dict, CloudType &owner)
 Selector. More...
 

Detailed Description

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

Collision model by P.J. O'Rourke.

Definition at line 47 of file ORourkeCollision.H.

Member Typedef Documentation

typedef CloudType::parcelType parcelType
protected

Convenience typedef to the cloud's parcel type.

Definition at line 56 of file ORourkeCollision.H.

Constructor & Destructor Documentation

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

Construct from dictionary.

Definition at line 267 of file ORourkeCollision.C.

Referenced by ORourkeCollision< CloudType >::collideSorted().

Here is the caller graph for this function:

Construct copy.

Definition at line 284 of file ORourkeCollision.C.

~ORourkeCollision ( )
virtual

Destructor.

Definition at line 297 of file ORourkeCollision.C.

Referenced by ORourkeCollision< CloudType >::clone().

Here is the caller graph for this function:

Member Function Documentation

void collide ( const scalar  dt)
protectedvirtual

Main collision routine.

Implements StochasticCollisionModel< CloudType >.

Reimplemented in TrajectoryCollision< CloudType >.

Definition at line 35 of file ORourkeCollision.C.

References Foam::cbrt(), ORourkeCollision< CloudType >::collideParcels(), forAllIter, p, and Foam::constant::mathematical::pi().

Here is the call graph for this function:

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 97 of file ORourkeCollision.C.

References ORourkeCollision< CloudType >::collideSorted(), Foam::exp(), Foam::mag(), Foam::min(), nu, Foam::constant::mathematical::pi(), and Foam::sqr().

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

Definition at line 147 of file ORourkeCollision.C.

References Foam::constant::mathematical::e(), f(), Foam::mag(), Foam::max(), Foam::min(), mTot, ORourkeCollision< CloudType >::ORourkeCollision(), Foam::pow3(), rho1, rho2, Foam::sqr(), Foam::sqrt(), U1, and U2.

Referenced by ORourkeCollision< CloudType >::collideParcels().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeName ( "ORourke"  )

Runtime type information.

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

Construct and return a clone.

Implements StochasticCollisionModel< CloudType >.

Reimplemented in TrajectoryCollision< CloudType >.

Definition at line 110 of file ORourkeCollision.H.

References ORourkeCollision< CloudType >::~ORourkeCollision().

Here is the call graph for this function:

Member Data Documentation

const liquidMixtureProperties& liquids_
protected

Definition at line 58 of file ORourkeCollision.H.

Switch coalescence_
protected

Coalescence activation switch.

Definition at line 61 of file ORourkeCollision.H.


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