template<class Init, class Coefficients>
walker::WrightFisher class

Wright-Fisher SDE used polymorphically with DiffEq.

Contents

The template arguments specify policies and are used to configure the behavior of the class. The policies are:

  • Init - initialization policy, see DiffEq/InitPolicy.h
  • Coefficients - coefficients policy, see DiffEq/WrightFisherCoeffPolicy.h

Constructors, destructors, conversion operators

WrightFisher(ncomp_t c) explicit
Constructor.

Public functions

void initialize(] int stream, tk::Particles& particles)
void advance(tk::Particles& particles, int stream, tk::real dt, tk::real, const std::map<tk::ctr::Product, tk::real>&)
Advance particles according to the Wright-Fisher SDE.

Function documentation

template<class Init, class Coefficients>
walker::WrightFisher<Init, Coefficients>::WrightFisher(ncomp_t c) explicit

Constructor.

Parameters
c in Index specifying which system of Wright-Fisher SDEs to construct. There can be multiple wright-fisher ... end blocks in a control file. This index specifies which Wright-Fisher SDE system to instantiate. The index corresponds to the order in which the wright-fisher ... end blocks are given the control file.

template<class Init, class Coefficients>
void walker::WrightFisher<Init, Coefficients>::initialize(] int stream, tk::Particles& particles)

Parameters
stream in Thread (or more precisely stream) ID
particles in/out Array of particle properties

Initalize SDE, prepare for time integration

Set initial conditions using initialization policy

template<class Init, class Coefficients>
void walker::WrightFisher<Init, Coefficients>::advance(tk::Particles& particles, int stream, tk::real dt, tk::real, const std::map<tk::ctr::Product, tk::real>&)

Advance particles according to the Wright-Fisher SDE.

Parameters
particles in/out Array of particle properties
stream in Thread (or more precisely stream) ID
dt in Time step size