NoCollision< CloudType > Class Template Reference

Place holder for 'none' option. More...

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

Public Member Functions

 TypeName ("none")
 Runtime type information. More...
 
 NoCollision (const dictionary &dict, CloudType &owner)
 Construct from components. More...
 
 NoCollision (const NoCollision< CloudType > &cm)
 Construct copy. More...
 
virtual autoPtr< CollisionModel< CloudType > > clone () const
 Construct and return a clone. More...
 
virtual ~NoCollision ()
 Destructor. More...
 
virtual label nSubCycles () const
 Return the number of times to subcycle the current. More...
 
virtual bool active () const
 Flag to indicate whether model activates collision model. 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from CollisionModel< CloudType >
static autoPtr< CollisionModel< CloudType > > New (const dictionary &dict, CloudType &owner)
 Selector. More...
 

Detailed Description

template<class CloudType>
class Foam::NoCollision< CloudType >

Place holder for 'none' option.

Source files

Definition at line 54 of file NoCollision.H.

Constructor & Destructor Documentation

◆ NoCollision() [1/2]

NoCollision ( const dictionary dict,
CloudType owner 
)

Construct from components.

Definition at line 34 of file NoCollision.C.

◆ NoCollision() [2/2]

NoCollision ( const NoCollision< CloudType > &  cm)

Construct copy.

Definition at line 45 of file NoCollision.C.

◆ ~NoCollision()

~NoCollision ( )
virtual

Destructor.

Definition at line 56 of file NoCollision.C.

Member Function Documentation

◆ TypeName()

TypeName ( "none"  )

Runtime type information.

◆ clone()

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

Construct and return a clone.

Implements CollisionModel< CloudType >.

Definition at line 74 of file NoCollision.H.

◆ nSubCycles()

Foam::label nSubCycles ( ) const
virtual

Return the number of times to subcycle the current.

timestep to meet the criteria of the collision model. For this model this will always be 1.

Implements CollisionModel< CloudType >.

Definition at line 63 of file NoCollision.C.

◆ active()

bool active ( ) const
virtual

Flag to indicate whether model activates collision model.

Definition at line 70 of file NoCollision.C.

◆ collide()

void collide ( )
virtual

Implements CollisionModel< CloudType >.

Definition at line 77 of file NoCollision.C.


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