SPH
Public Member Functions | List of all members
ITimeStepCriterion Class Referenceabstract

Base class for timestep setters. More...

#include <TimeStepCriterion.h>

Inheritance diagram for ITimeStepCriterion:
Polymorphic AccelerationCriterion CourantCriterion DerivativeCriterion DivergenceCriterion MultiCriterion

Public Member Functions

virtual TimeStep compute (IScheduler &scheduler, Storage &storage, Float maxStep, Statistics &stats)=0
 Computes the value of the time step. More...
 
- Public Member Functions inherited from Polymorphic
virtual ~Polymorphic ()
 

Detailed Description

Base class for timestep setters.

Definition at line 38 of file TimeStepCriterion.h.

Member Function Documentation

◆ compute()

virtual TimeStep ITimeStepCriterion::compute ( IScheduler scheduler,
Storage storage,
Float  maxStep,
Statistics stats 
)
pure virtual

Computes the value of the time step.

Parameters
schedulerScheduler than can be used for parallelization.
storageStorage containing all physical quantities from which the time step is determined.
maxStepMaximal allowed time step.
statsUsed to save statistics of the criterion.
Returns
Computed time step and ID of criterion that determined the value.

Implemented in CourantCriterion, DivergenceCriterion, AccelerationCriterion, DerivativeCriterion, and MultiCriterion.


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