AR::TimeTransformedSymplecticManager< Tmethod > Class Template Reference

Time Transformed Symplectic integrator manager. More...

#include <symplectic_integrator.h>

Collaboration diagram for AR::TimeTransformedSymplecticManager< Tmethod >:

Public Member Functions
	TimeTransformedSymplecticManager ()
	class to manager kick drift step More...
bool	checkParams ()
	check whether parameters values are correct More...
void	writeBinary (FILE *_fout)
	write class data with BINARY format More...
void	readBinary (FILE *_fin, int _version=0)
	read class data with BINARY format and initial the array More...
void	print (std::ostream &_fout) const
	print parameters More...

Public Attributes
Float	time_error_max
Float	energy_error_relative_max
	maximum time error (absolute), should be positive and larger than round-off error More...
Float	time_step_min
	maximum energy error requirement More...
Float	ds_scale
	minimum real time step allown More...
Float	slowdown_pert_ratio_ref
	scaling factor to determine ds More...
Float	slowdown_timescale_max
	slowdown perturbation /inner ratio reference factor More...
long long unsigned int	step_count_max
	slowdown maximum timescale to calculate maximum slowdown factor More...
int	interrupt_detection_option
	maximum step counts More...
Tmethod	interaction
	1: detect interruption; 0: no detection More...
SymplecticStep	step
	class contain interaction function More...

Detailed Description

template<class Tmethod>
class AR::TimeTransformedSymplecticManager< Tmethod >

Time Transformed Symplectic integrator manager.

Tmethod is the class contain the interaction function, see sample of interaction.h:

Constructor & Destructor Documentation

TimeTransformedSymplecticManager()

template<class Tmethod >

AR::TimeTransformedSymplecticManager< Tmethod >::TimeTransformedSymplecticManager ( )

inline

class to manager kick drift step

constructor

Member Function Documentation

checkParams()

template<class Tmethod >

bool AR::TimeTransformedSymplecticManager< Tmethod >::checkParams ( )

inline

check whether parameters values are correct

Returns

true: all correct

Here is the caller graph for this function:

print()

template<class Tmethod >

void AR::TimeTransformedSymplecticManager< Tmethod >::print ( std::ostream &  _fout ) const

inline

print parameters

readBinary()

template<class Tmethod >

void AR::TimeTransformedSymplecticManager< Tmethod >::readBinary ( FILE *  _fin, int  _version = 0  )

inline

read class data with BINARY format and initial the array

Parameters

[in]	_fin	file IO for read
[in]	_version	version for reading. 0: default; 1: missing ds_scale

writeBinary()

template<class Tmethod >

void AR::TimeTransformedSymplecticManager< Tmethod >::writeBinary ( FILE *  _fout )

inline

write class data with BINARY format

Parameters

[in]

_fout

file IO for write

Member Data Documentation

ds_scale

template<class Tmethod >

Float AR::TimeTransformedSymplecticManager< Tmethod >::ds_scale

minimum real time step allown

energy_error_relative_max

template<class Tmethod >

Float AR::TimeTransformedSymplecticManager< Tmethod >::energy_error_relative_max

maximum time error (absolute), should be positive and larger than round-off error

interaction

template<class Tmethod >

Tmethod AR::TimeTransformedSymplecticManager< Tmethod >::interaction

1: detect interruption; 0: no detection

interrupt_detection_option

template<class Tmethod >

int AR::TimeTransformedSymplecticManager< Tmethod >::interrupt_detection_option

maximum step counts

slowdown_pert_ratio_ref

template<class Tmethod >

Float AR::TimeTransformedSymplecticManager< Tmethod >::slowdown_pert_ratio_ref

scaling factor to determine ds

slowdown_timescale_max

template<class Tmethod >

Float AR::TimeTransformedSymplecticManager< Tmethod >::slowdown_timescale_max

slowdown perturbation /inner ratio reference factor

step

template<class Tmethod >

SymplecticStep AR::TimeTransformedSymplecticManager< Tmethod >::step

class contain interaction function

step_count_max

template<class Tmethod >

long long unsigned int AR::TimeTransformedSymplecticManager< Tmethod >::step_count_max

slowdown maximum timescale to calculate maximum slowdown factor

time_error_max

template<class Tmethod >

Float AR::TimeTransformedSymplecticManager< Tmethod >::time_error_max

time_step_min

template<class Tmethod >

Float AR::TimeTransformedSymplecticManager< Tmethod >::time_step_min

maximum energy error requirement

---

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

• symplectic_integrator.h