NoInteraction< CloudType > Class Template Reference

Dummy class for 'none' option - will raise an error if any functions are called that require return values. More...

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

Public Member Functions

 TypeName ("none")
 Runtime type information. More...
 
 NoInteraction (const dictionary &dict, CloudType &cloud)
 Construct from dictionary. More...
 
 NoInteraction (const NoInteraction< CloudType > &pim)
 Construct copy. More...
 
virtual autoPtr< PatchInteractionModel< CloudType > > clone () const
 Construct and return a clone. More...
 
virtual ~NoInteraction ()=default
 Destructor. More...
 
virtual bool active () const
 Flag to indicate whether model activates patch interaction model. More...
 
virtual bool correct (typename CloudType::parcelType &p, const polyPatch &pp, bool &keepParticle)
 Apply velocity correction. More...
 
- Public Member Functions inherited from PatchInteractionModel< CloudType >
 TypeName ("patchInteractionModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, PatchInteractionModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
 Declare runtime constructor selection table. More...
 
 PatchInteractionModel (CloudType &owner)
 Construct null from owner. More...
 
 PatchInteractionModel (const dictionary &dict, CloudType &owner, const word &type)
 Construct from components. More...
 
 PatchInteractionModel (const PatchInteractionModel< CloudType > &pim)
 Construct copy. More...
 
virtual ~PatchInteractionModel ()=default
 Destructor. More...
 
const wordUName () const
 Return name of velocity field. More...
 
const scalar & Urmax () const
 Return Urmax. More...
 
virtual void addToEscapedParcels (const scalar mass)
 Add to escaped parcels. More...
 
virtual void postEvolve ()
 Post-evolve hook. More...
 
virtual void info (Ostream &os)
 Write patch interaction info to stream. More...
 

Additional Inherited Members

- Public Types inherited from PatchInteractionModel< CloudType >
enum  interactionType {
  itNone, itRebound, itStick, itEscape,
  itOther
}
 
- Static Public Member Functions inherited from PatchInteractionModel< CloudType >
static autoPtr< PatchInteractionModel< CloudType > > New (const dictionary &dict, CloudType &owner)
 Selector. More...
 
static word interactionTypeToWord (const interactionType &itEnum)
 Convert interaction result to word. More...
 
static interactionType wordToInteractionType (const word &itWord)
 Convert word to interaction result. More...
 
- Static Public Attributes inherited from PatchInteractionModel< CloudType >
static wordList interactionTypeNames_
 
- Protected Member Functions inherited from PatchInteractionModel< CloudType >
virtual void writeFileHeader (Ostream &os)
 Output file header information. More...
 
- Protected Attributes inherited from PatchInteractionModel< CloudType >
const word UName_
 Name of velocity field - default = "U". More...
 
label escapedParcels_
 Number of parcels escaped. More...
 
scalar escapedMass_
 Mass of parcels escaped. More...
 
scalar Urmax_
 Maximum relative U with patch for particle to be removed. More...
 

Detailed Description

template<class CloudType>
class Foam::NoInteraction< CloudType >

Dummy class for 'none' option - will raise an error if any functions are called that require return values.

Definition at line 51 of file NoInteraction.H.

Constructor & Destructor Documentation

◆ NoInteraction() [1/2]

NoInteraction ( const dictionary dict,
CloudType cloud 
)

Construct from dictionary.

Definition at line 34 of file NoInteraction.C.

◆ NoInteraction() [2/2]

NoInteraction ( const NoInteraction< CloudType > &  pim)

Construct copy.

Definition at line 45 of file NoInteraction.C.

◆ ~NoInteraction()

virtual ~NoInteraction ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "none"  )

Runtime type information.

◆ clone()

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

Construct and return a clone.

Implements PatchInteractionModel< CloudType >.

Definition at line 70 of file NoInteraction.H.

◆ active()

bool active ( ) const
virtual

Flag to indicate whether model activates patch interaction model.

Definition at line 56 of file NoInteraction.C.

◆ correct()

bool correct ( typename CloudType::parcelType p,
const polyPatch pp,
bool keepParticle 
)
virtual

Apply velocity correction.

Returns true if particle remains in same cell

Implements PatchInteractionModel< CloudType >.

Definition at line 64 of file NoInteraction.C.


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