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

BSE based code event recorder class. More...

#include <bse_interface.h>

Public Member Functions

void recordEvent (const StarParameter &_p1, const StarParameter &_p2, const double _semi, const double _ecc, const int _type, const int _index)
 set up the initial parameter of binary event based on the present status of a binary More...
 
void setEventIndexEnd (const int index)
 set binary type to -1 for the given event index to indicate the end of record More...
 
int getEventNMax () const
 Maximum event number that can be recored in one call of evolv2. More...
 
int getEventIndexInit () const
 The index of initial event in record array (last one) More...
 
int getType (const int index) const
 Get the binary type. More...
 
void print (std::ostream &fout, const int index) const
 for print in one line More...
 
void printColumn (std::ostream &_fout, const int _index, const int _width=20) const
 print data of class members using column style More...
 

Static Public Member Functions

static void printColumnTitle (std::ostream &_fout, const int _width=20)
 print titles of class members using column style More...
 

Public Attributes

double record [20][9]
 

Detailed Description

BSE based code event recorder class.

The binary evolution parameters record in the bpp array of evolv2

Member Function Documentation

◆ getEventIndexInit()

int BinaryEvent::getEventIndexInit ( ) const
inline

The index of initial event in record array (last one)

Here is the caller graph for this function:

◆ getEventNMax()

int BinaryEvent::getEventNMax ( ) const
inline

Maximum event number that can be recored in one call of evolv2.

Here is the caller graph for this function:

◆ getType()

int BinaryEvent::getType ( const int  index) const
inline

Get the binary type.

◆ print()

void BinaryEvent::print ( std::ostream &  fout,
const int  index 
) const
inline

for print in one line

◆ printColumn()

void BinaryEvent::printColumn ( std::ostream &  _fout,
const int  _index,
const int  _width = 20 
) const
inline

print data of class members using column style

print data of class members in one line for column style. Notice no newline is printed at the end

Parameters
[out]_foutstd::ostream output object
[in]_widthprint width (defaulted 20)
[in]_indexevent index to print

◆ printColumnTitle()

static void BinaryEvent::printColumnTitle ( std::ostream &  _fout,
const int  _width = 20 
)
inlinestatic

print titles of class members using column style

print titles of class members in one line for column style

Parameters
[out]_foutstd::ostream output object
[in]_widthprint width (defaulted 20)

◆ recordEvent()

void BinaryEvent::recordEvent ( const StarParameter _p1,
const StarParameter _p2,
const double  _semi,
const double  _ecc,
const int  _type,
const int  _index 
)
inline

set up the initial parameter of binary event based on the present status of a binary

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setEventIndexEnd()

void BinaryEvent::setEventIndexEnd ( const int  index)
inline

set binary type to -1 for the given event index to indicate the end of record

Here is the caller graph for this function:

Member Data Documentation

◆ record

double BinaryEvent::record[20][9]

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