Public Member Functions | List of all members
PairCollision< CloudType > Class Template Reference
Inheritance diagram for PairCollision< CloudType >:
Inheritance graph
[legend]
Collaboration diagram for PairCollision< CloudType >:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("pairCollision")
 Runtime type information. More...
 
 PairCollision (const dictionary &dict, CloudType &owner)
 Construct from components. More...
 
 PairCollision (const PairCollision< CloudType > &cm)
 Construct copy. More...
 
virtual autoPtr< CollisionModel< CloudType > > clone () const
 Construct and return a clone. More...
 
virtual ~PairCollision ()
 Destructor. More...
 
virtual label nSubCycles () const
 Return the number of times to subcycle the current. More...
 
virtual bool controlsWallInteraction () const
 Indicates whether model determines wall collisions or not,. More...
 
virtual void collide ()
 
- Public Member Functions inherited from CollisionModel< CloudType >
 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 ~CollisionModel ()
 Destructor. 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...
 

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 CollisionModel< CloudType >
static autoPtr< CollisionModel< CloudType > > New (const dictionary &dict, CloudType &owner)
 Selector. 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::PairCollision< CloudType >

Source files

Definition at line 59 of file PairCollision.H.

Constructor & Destructor Documentation

PairCollision ( const dictionary dict,
CloudType owner 
)

Construct from components.

Definition at line 560 of file PairCollision.C.

Construct copy.

Definition at line 601 of file PairCollision.C.

References NotImplemented.

~PairCollision ( )
virtual

Destructor.

Definition at line 618 of file PairCollision.C.

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

Here is the caller graph for this function:

Member Function Documentation

TypeName ( "pairCollision"  )

Runtime type information.

virtual autoPtr<CollisionModel<CloudType> > clone ( ) const
inlinevirtual
Foam::label nSubCycles ( ) const
virtual

Return the number of times to subcycle the current.

timestep to meet the criteria of the collision model.

Implements CollisionModel< CloudType >.

Definition at line 625 of file PairCollision.C.

References Foam::max(), and Foam::returnReduce().

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

Here is the call graph for this function:

Here is the caller graph for this function:

bool controlsWallInteraction ( ) const
virtual

Indicates whether model determines wall collisions or not,.

used to determine what value to use for wallImpactDistance

Implements CollisionModel< CloudType >.

Definition at line 654 of file PairCollision.C.

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

Here is the caller graph for this function:

void collide ( )
virtual

Implements CollisionModel< CloudType >.

Definition at line 661 of file PairCollision.C.

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

Here is the caller graph for this function:


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