All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
relative Class Reference

Correction limiting method based on the relative particle velocity. More...

Inheritance diagram for relative:
Collaboration diagram for relative:

Public Member Functions

 TypeName ("relative")
 Runtime type information. More...
 
 relative (const dictionary &dict)
 Construct from components. More...
 
 relative (const relative &cl)
 Copy constructor. More...
 
virtual autoPtr< CorrectionLimitingMethodclone () const
 Construct and return a clone. More...
 
virtual ~relative ()
 Destructor. More...
 
virtual vector limitedVelocity (const vector uP, const vector dU, const vector uMean) const
 Return the limited velocity. More...
 
- Public Member Functions inherited from CorrectionLimitingMethod
 TypeName ("correctionLimitingMethod")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, CorrectionLimitingMethod, dictionary,(const dictionary &dict),(dict))
 Declare runtime constructor selection table. More...
 
 CorrectionLimitingMethod (const dictionary &dict)
 Construct from components. More...
 
 CorrectionLimitingMethod (const CorrectionLimitingMethod &cl)
 Copy constructor. More...
 
virtual ~CorrectionLimitingMethod ()
 Destructor. More...
 
void operator= (const CorrectionLimitingMethod &)=delete
 Disallow default bitwise assignment. More...
 

Protected Attributes

scalar e_
 Coefficient of restitution. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from CorrectionLimitingMethod
static autoPtr< CorrectionLimitingMethodNew (const dictionary &dict)
 Selector. More...
 

Detailed Description

Correction limiting method based on the relative particle velocity.

This method limits the velocity correction to that of a rebound with a coefficient of restitution $e$. The relative velocity of the particle with respect to the mean value is used to calculate the direction and magnitude of the limited velocity.

Source files

Definition at line 55 of file relative.H.

Constructor & Destructor Documentation

◆ relative() [1/2]

relative ( const dictionary dict)

Construct from components.

Definition at line 46 of file relative.C.

Referenced by relative::clone().

Here is the caller graph for this function:

◆ relative() [2/2]

relative ( const relative cl)

Copy constructor.

Definition at line 53 of file relative.C.

◆ ~relative()

~relative ( )
virtual

Destructor.

Definition at line 62 of file relative.C.

References relative::limitedVelocity().

Referenced by relative::clone().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "relative"  )

Runtime type information.

◆ clone()

virtual autoPtr<CorrectionLimitingMethod> clone ( ) const
inlinevirtual

Construct and return a clone.

Implements CorrectionLimitingMethod.

Definition at line 82 of file relative.H.

References relative::limitedVelocity(), relative::relative(), and relative::~relative().

Here is the call graph for this function:

◆ limitedVelocity()

Foam::vector limitedVelocity ( const vector  uP,
const vector  dU,
const vector  uMean 
) const
virtual

Return the limited velocity.

Implements CorrectionLimitingMethod.

Definition at line 69 of file relative.C.

References relative::e_, and Foam::minMod().

Referenced by relative::clone(), and relative::~relative().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ e_

scalar e_
protected

Coefficient of restitution.

Definition at line 64 of file relative.H.

Referenced by relative::limitedVelocity().


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