Interface Model.HasDE

All Known Subinterfaces:
Model.HasDE.DPairs, Model.HasDE.EM, Model.HasDE.ODE, Model.HasDE.PDE, Model.HasDE.PDEADV, Model.HasDE.PDERD, Model.HasDE.RK5, Model.HasDE.SDE
All Known Implementing Classes:
ATBT, CDL, CDLP, CDLPQ, DemesTBT, EcoPGG, LV, Moran, Predator, RSP, simCDL, simCDLP, simCDLPQ, simMoran, simTBT, simTraits, SIR, TBT, Traits
Enclosing class:
Model

public static interface Model.HasDE
Methods that every Module must implement, which advertises numerical solutions based on differential equations.
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    Interface for differential equation models with interactions in groups of arbitrary size.
    static interface 
    Interface for differential equation models with pairwise interactions.
    static interface 
    Interface for modules that support differential equation models with both frequency and density based dynamics.
    static interface 
    Interface for ordinary differential equation models using the Euler-Maruyama method.
    static interface 
    Interface for ordinary differential equation models; defaults to RK5.
    static interface 
    Interface for partial differential equation models; defaults to PDERD.
    static interface 
    Interface for reaction-diffusion-advection partial differential equation models.
    static interface 
    Interface for reaction-diffusion partial differential equation models.
    static interface 
    Interface for ordinary differential equation models using the fifth order Runge-Kutta method.
    static interface 
    Interface for stochastic differential equation models.
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    For replicator dynamics the frequencies of all traits must sum up to one.
  • Method Details

    • getDependent

      int getDependent()
      For replicator dynamics the frequencies of all traits must sum up to one. Hence, for nTraits traits there are only nTraits-1 degrees of freedom. The index returned by getDependent() marks the one rate of change that is derived from all the others.

      Notes:

      • Dependent traits are used by models where the frequencies of all types must sum up to one.
      • Density modules do not have dependent traits and getDependent() should return -1.
      • Currently differential equations implementations are only provided for Discrete modules.
      Returns:
      the index of the dependent trait (or -1 if there is none)