PeTar
N-body code for collisional gravitational systems
KickDriftStep Class Reference

#include <kickdriftstep.hpp>

Public Member Functions

 KickDriftStep ()
 
void resetCountOneStep ()
 reset step count for one full step case More...
 
void resetCountContinue ()
 reset step count for continuing case More...
 
void nextOneStep ()
 advance step count for one full step case More...
 
void nextContinue ()
 advance step count for continuing case More...
 
PS::S32 getCountOneStep () const
 get step count for one full step case More...
 
PS::S32 getCountContinue () const
 get step count for continue case More...
 
void setDKDMode ()
 set DKD mode (default is KDK) More...
 
void setKDKMode ()
 set DKD mode (default is KDK) More...
 
void setStep (const PS::F64 _ds)
 set base step size More...
 
PS::F64 getStep () const
 get base step size More...
 
PS::F64 getDtKickOneStep () const
 Get kick step size for one full step. More...
 
PS::F64 getDtDriftOneStep () const
 Get drift step size for one full step
More...
 
PS::F64 getDtKickContinue ()
 Get kick step size for continue case. More...
 
PS::F64 getDtDriftContinue ()
 Get drift step size for continue case. More...
 
PS::F64 getDtStartContinue ()
 Get staring step size for continue case. More...
 
PS::F64 getDtEndContinue ()
 Get ending step size for continue case. More...
 
bool isNextStart () const
 get whether next is start More...
 
bool isNextEndPossible () const
 get whether next can be end More...
 

Constructor & Destructor Documentation

◆ KickDriftStep()

KickDriftStep::KickDriftStep ( )
inline

Member Function Documentation

◆ getCountContinue()

PS::S32 KickDriftStep::getCountContinue ( ) const
inline

get step count for continue case

Returns
index of step array, 0 indicate the starting/ending step

◆ getCountOneStep()

PS::S32 KickDriftStep::getCountOneStep ( ) const
inline

get step count for one full step case

◆ getDtDriftContinue()

PS::F64 KickDriftStep::getDtDriftContinue ( )
inline

Get drift step size for continue case.

◆ getDtDriftOneStep()

PS::F64 KickDriftStep::getDtDriftOneStep ( ) const
inline

Get drift step size for one full step

◆ getDtEndContinue()

PS::F64 KickDriftStep::getDtEndContinue ( )
inline

Get ending step size for continue case.

Here is the call graph for this function:

◆ getDtKickContinue()

PS::F64 KickDriftStep::getDtKickContinue ( )
inline

Get kick step size for continue case.

◆ getDtKickOneStep()

PS::F64 KickDriftStep::getDtKickOneStep ( ) const
inline

Get kick step size for one full step.

◆ getDtStartContinue()

PS::F64 KickDriftStep::getDtStartContinue ( )
inline

Get staring step size for continue case.

◆ getStep()

PS::F64 KickDriftStep::getStep ( ) const
inline

get base step size

◆ isNextEndPossible()

bool KickDriftStep::isNextEndPossible ( ) const
inline

get whether next can be end

Here is the caller graph for this function:

◆ isNextStart()

bool KickDriftStep::isNextStart ( ) const
inline

get whether next is start

◆ nextContinue()

void KickDriftStep::nextContinue ( )
inline

advance step count for continuing case

◆ nextOneStep()

void KickDriftStep::nextOneStep ( )
inline

advance step count for one full step case

◆ resetCountContinue()

void KickDriftStep::resetCountContinue ( )
inline

reset step count for continuing case

◆ resetCountOneStep()

void KickDriftStep::resetCountOneStep ( )
inline

reset step count for one full step case

◆ setDKDMode()

void KickDriftStep::setDKDMode ( )
inline

set DKD mode (default is KDK)

◆ setKDKMode()

void KickDriftStep::setKDKMode ( )
inline

set DKD mode (default is KDK)

◆ setStep()

void KickDriftStep::setStep ( const PS::F64  _ds)
inline

set base step size


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