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

IO parameters for Galpy manager. More...

#include <galpy_interface.h>

Collaboration diagram for IOParamsGalpy:
[legend]

Public Member Functions

 IOParamsGalpy ()
 
int read (int argc, char *argv[], const int opt_used_pre=0)
 reading parameters from GNU option API More...
 
void setBovyUnit (const bool print_flag=true)
 set Bovy unit scale factor (solar distance and velocityr referring to the Galactic center) converge from astronomical unit set (Myr, Msun, pc) More...
 

Public Attributes

IOParamsContainer input_par_store
 
IOParams< std::string > type_args
 
IOParams< std::string > pre_define_type
 
IOParams< std::string > config_filename
 
IOParams< double > rscale
 
IOParams< double > vscale
 
bool print_flag
 

Detailed Description

IO parameters for Galpy manager.

Constructor & Destructor Documentation

◆ IOParamsGalpy()

IOParamsGalpy::IOParamsGalpy ( )
inline

Member Function Documentation

◆ read()

int IOParamsGalpy::read ( int  argc,
char *  argv[],
const int  opt_used_pre = 0 
)
inline

reading parameters from GNU option API

Parameters
[in]argcnumber of options
[in]argvstring of options
[in]opt_used_prealready used option number from previous reading, use to correctly count the remaining argument number
Returns
-1 if help is used; else the used number of argv
Here is the call graph for this function:
Here is the caller graph for this function:

◆ setBovyUnit()

void IOParamsGalpy::setBovyUnit ( const bool  print_flag = true)
inline

set Bovy unit scale factor (solar distance and velocityr referring to the Galactic center) converge from astronomical unit set (Myr, Msun, pc)

Member Data Documentation

◆ config_filename

IOParams<std::string> IOParamsGalpy::config_filename

◆ input_par_store

IOParamsContainer IOParamsGalpy::input_par_store

◆ pre_define_type

IOParams<std::string> IOParamsGalpy::pre_define_type

◆ print_flag

bool IOParamsGalpy::print_flag

◆ rscale

IOParams<double> IOParamsGalpy::rscale

◆ type_args

IOParams<std::string> IOParamsGalpy::type_args

◆ vscale

IOParams<double> IOParamsGalpy::vscale

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