TrajectoryCollision< CloudType > Class Template Reference

Trajectory collision model by N. Nordin, based on O'Rourke's collision model. More...

Inheritance diagram for TrajectoryCollision< CloudType >:
[legend]
Collaboration diagram for TrajectoryCollision< CloudType >:
[legend]

Public Member Functions

 TypeName ("trajectory")
 Runtime type information. More...
 
 TrajectoryCollision (const dictionary &dict, CloudType &cloud)
 Construct from dictionary. More...
 
 TrajectoryCollision (const TrajectoryCollision< CloudType > &cm)
 Construct copy. More...
 
virtual autoPtr< StochasticCollisionModel< CloudType > > clone () const
 Construct and return a clone. More...
 
virtual ~TrajectoryCollision ()
 Destructor. More...
 
- Public Member Functions inherited from ORourkeCollision< CloudType >
 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 autoPtr< StochasticCollisionModel< CloudType > > clone () const =0
 Construct and return a clone. More...
 
virtual ~StochasticCollisionModel ()
 Destructor. More...
 
void update (typename CloudType::parcelType::trackingData &td, 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 writeTime () const
 Flag to indicate when to write a property. More...
 
virtual fileName localPath () const
 Output directory. 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 dependent sub-model fields. More...
 
virtual bool writeTime () const
 Flag to indicate when to write a property. More...
 
virtual fileName localPath () const
 Output directory. More...
 
template<class Type >
Type getBaseProperty (const word &entryName, const Type &defaultValue=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...
 
bool getModelDict (const word &entryName, dictionary &dict) const
 Retrieve dictionary, return true if set. More...
 
template<class Type >
bool 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=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...
 
virtual void write (Ostream &os) const
 Write. More...
 

Protected Types

typedef CloudType::parcelType parcelType
 Convenience typedef to the cloud's parcel type. More...
 
- Protected Types inherited from ORourkeCollision< CloudType >
typedef CloudType::parcelType parcelType
 Convenience typedef to the cloud's parcel type. More...
 

Protected Member Functions

virtual void collide (typename CloudType::parcelType::trackingData &td, 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...
 
- Protected Member Functions inherited from ORourkeCollision< CloudType >
virtual void collide (typename CloudType::parcelType::trackingData &td, 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)
 
virtual void collide (typename CloudType::parcelType::trackingData &td, const scalar dt)=0
 Main collision routine. More...
 
- Protected Member Functions inherited from subModelBase
bool inLine () const
 Flag to indicate whether data is/was read in-line. More...
 

Protected Attributes

scalar cSpace_
 Space coefficient. More...
 
scalar cTime_
 Time coefficient. More...
 
- Protected Attributes inherited from ORourkeCollision< CloudType >
const liquidMixturePropertiesliquids_
 
bool coalescence_
 Coalescence activated? 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::TrajectoryCollision< CloudType >

Trajectory collision model by N. Nordin, based on O'Rourke's collision model.

Definition at line 48 of file TrajectoryCollision.H.

Member Typedef Documentation

◆ parcelType

typedef CloudType::parcelType parcelType
protected

Convenience typedef to the cloud's parcel type.

Definition at line 57 of file TrajectoryCollision.H.

Constructor & Destructor Documentation

◆ TrajectoryCollision() [1/2]

TrajectoryCollision ( const dictionary dict,
CloudType cloud 
)

Construct from dictionary.

Definition at line 137 of file TrajectoryCollision.C.

◆ TrajectoryCollision() [2/2]

Construct copy.

Definition at line 150 of file TrajectoryCollision.C.

◆ ~TrajectoryCollision()

Destructor.

Definition at line 164 of file TrajectoryCollision.C.

Member Function Documentation

◆ collide()

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

Main collision routine.

Reimplemented from ORourkeCollision< CloudType >.

Definition at line 33 of file TrajectoryCollision.C.

◆ collideParcels()

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

Collide parcels and return true if mass has changed.

Reimplemented from ORourkeCollision< CloudType >.

Definition at line 44 of file TrajectoryCollision.C.

References alpha, beta(), Foam::det(), Foam::exp(), Foam::mag(), max(), Foam::pow(), Foam::sqr(), U1, and U2.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "trajectory"  )

Runtime type information.

◆ clone()

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

Construct and return a clone.

Reimplemented from ORourkeCollision< CloudType >.

Definition at line 101 of file TrajectoryCollision.H.

Member Data Documentation

◆ cSpace_

scalar cSpace_
protected

Space coefficient.

Definition at line 60 of file TrajectoryCollision.H.

◆ cTime_

scalar cTime_
protected

Time coefficient.

Definition at line 63 of file TrajectoryCollision.H.


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