advance_cluster¶
- clustertools.io.load.advance_cluster(cluster, load_function=None, ofile=None, orbit=None, filename=None, **kwargs)[source]¶
Advance a loaded StarCluster snapshot to the next timestep
ofile or orbit need to be provded again, same as load_cluster.
Be sure that advance is set to True so next line of orbit file is read in
if last snapshot has been reached, returns an empty StarCluster
- Parameters:
- cluster - class
StarCluster to be advanced
- load_functionfunction
use a custom function to load data (default : None)
- ofilefile
an already opened file containing orbit information (default: None)
- orbitclass
a galpy orbit to be used for the StarCluster’s orbital information (default: None)
- filename :str
name of file to be opened (optional - necessary if no defaults assigned to ctype) (default: None)
- Returns:
- clusterclass
StarCluster
- Other Parameters:
- Same as load_cluster except for:
- dtoutinteger
number of nbody timesteps forward to advance to next Nbody6++ timestep (default = 1)