Public Member Functions | List of all members
CustomMotionCriteria Class Referenceabstract

Class for checking if the criteria for custom motion is applied. More...

#include <CustomMotion.hpp>

Public Member Functions

virtual bool SatisfyCriteria (size_t index, Tessellation const &tess, vector< ComputationalCell > const &cells, double time, vector< Vector2D > const &velocities, double dt, TracerStickerNames const &ts) const =0
 Check if a point satisfies a certain criterion. More...
 
virtual Vector2D CustomVelocityResult (size_t index, Tessellation const &tess, vector< ComputationalCell > const &cells, double time, vector< Vector2D > const &velocities, double dt, TracerStickerNames const &ts) const =0
 Calculates custom velocity. More...
 
virtual ~CustomMotionCriteria (void)
 Class destructor.
 

Detailed Description

Class for checking if the criteria for custom motion is applied.

Definition at line 12 of file CustomMotion.hpp.

Member Function Documentation

◆ CustomVelocityResult()

virtual Vector2D CustomMotionCriteria::CustomVelocityResult ( size_t  index,
Tessellation const &  tess,
vector< ComputationalCell > const &  cells,
double  time,
vector< Vector2D > const &  velocities,
double  dt,
TracerStickerNames const &  ts 
) const
pure virtual

Calculates custom velocity.

Parameters
indexCall index
tessTessellation
cellsComputational cells
timeTime
velocitiesThe original velocities
dtTime step
tsThe names of the tracers and stickers
Returns
Custom velocity
Here is the caller graph for this function:

◆ SatisfyCriteria()

virtual bool CustomMotionCriteria::SatisfyCriteria ( size_t  index,
Tessellation const &  tess,
vector< ComputationalCell > const &  cells,
double  time,
vector< Vector2D > const &  velocities,
double  dt,
TracerStickerNames const &  ts 
) const
pure virtual

Check if a point satisfies a certain criterion.

Parameters
indexCell index
tessTessellation
cellsComputational cells
timeTime
dtThe time step
velocitiesThe mesh point velocitites
tsThe names of the tracers and stickers
Returns
True if condition is met
Here is the caller graph for this function:

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