CollisionModel< CloudType > Class Template Referenceabstract

Templated collision model class. More...

Inheritance diagram for CollisionModel< CloudType >:
Collaboration diagram for CollisionModel< CloudType >:

Public Member Functions

 TypeName ("collisionModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, CollisionModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
 Declare runtime constructor selection table. More...
 
 CollisionModel (CloudType &owner)
 Construct null from owner. More...
 
 CollisionModel (const dictionary &dict, CloudType &owner, const word &type)
 Construct from components. More...
 
 CollisionModel (const CollisionModel< CloudType > &cm)
 Construct copy. More...
 
virtual autoPtr< CollisionModel< CloudType > > clone () const =0
 Construct and return a clone. More...
 
virtual ~CollisionModel ()
 Destructor. More...
 
virtual label nSubCycles () const =0
 Return the number of times to subcycle the current. More...
 
virtual void collide ()=0
 
- 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)
 Copy constructor. 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...
 
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)
 Copy constructor. 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 void cacheFields (const bool store)
 Cache dependent 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...
 
void operator= (const subModelBase &)=delete
 Disallow default bitwise assignment. More...
 

Static Public Member Functions

static autoPtr< CollisionModel< CloudType > > New (const dictionary &dict, CloudType &owner)
 Selector. More...
 

Additional Inherited Members

- Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType cloudType
 Type of cloud this model was instantiated for. More...
 
- Protected Member Functions inherited from subModelBase
bool inLine () const
 Flag to indicate whether data is/was read in-line. 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...
 

Detailed Description

template<class CloudType>
class Foam::CollisionModel< CloudType >

Templated collision model class.

Source files

Definition at line 53 of file CollisionModel.H.

Constructor & Destructor Documentation

◆ CollisionModel() [1/3]

CollisionModel ( CloudType owner)

Construct null from owner.

Definition at line 31 of file CollisionModel.C.

◆ CollisionModel() [2/3]

CollisionModel ( const dictionary dict,
CloudType owner,
const word type 
)

Construct from components.

Definition at line 38 of file CollisionModel.C.

◆ CollisionModel() [3/3]

Construct copy.

Definition at line 50 of file CollisionModel.C.

◆ ~CollisionModel()

~CollisionModel
virtual

Destructor.

Definition at line 62 of file CollisionModel.C.

Member Function Documentation

◆ TypeName()

TypeName ( "collisionModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
CollisionModel< CloudType ,
dictionary  ,
(const dictionary &dict, CloudType &owner ,
(dict, owner  
)

Declare runtime constructor selection table.

◆ clone()

virtual autoPtr<CollisionModel<CloudType> > clone ( ) const
pure virtual

Construct and return a clone.

Implemented in PairCollision< CloudType >, and NoCollision< CloudType >.

◆ New()

Foam::autoPtr< Foam::CollisionModel< CloudType > > New ( const dictionary dict,
CloudType owner 
)
static

Selector.

Definition at line 32 of file CollisionModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, and Foam::nl.

Here is the call graph for this function:

◆ nSubCycles()

virtual label nSubCycles ( ) const
pure virtual

Return the number of times to subcycle the current.

timestep to meet the criteria of the collision model

Implemented in PairCollision< CloudType >, and NoCollision< CloudType >.

◆ collide()

virtual void collide ( )
pure virtual

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