swiftest.Simulation.set_init_cond_files

swiftest.Simulation.set_init_cond_files#

Simulation.set_init_cond_files(init_cond_file_type=None, init_cond_file_name=None, init_cond_format=None, **kwargs)[source]#

Sets the initial condition file parameters in the parameters dictionary.

Parameters:

  • init_cond_file_type ({“NETCDF_DOUBLE”, “NETCDF_FLOAT”, “ASCII”}, optional) – The file type containing initial conditions for the simulation

    • NETCDF_DOUBLE: A single initial conditions input file in NetCDF file format of type NETCDF_DOUBLE

    • NETCDF_FLOAT: A single initial conditions input file in NetCDF file format of type NETCDF_FLOAT

    • ASCII : Three initial conditions files in ASCII format. The individual files define the central body, massive body, and test particle initial conditions.

  • init_cond_file_name (str, path-like, or dict, optional) – Name of the input initial condition file or files. Whether to pass a single file name or a dictionary depends on the argument passed to init_cond_file_type: If init_cond_file_type={“NETCDF_DOUBLE”,”NETCDF_FLOAT”}, then this will be a single file name. If init_cond_file_type=”ASCII” then this must be a dictionary where:

    init_cond_file_name = {
    "CB" : *path to central body initial conditions file* (Swiftest only),
    "PL" : *path to massive body initial conditions file*,
    "TP" : *path to test particle initial conditions file*
    }

    If no file name is provided then the following default file names will be used.

    • NETCDF_DOUBLE, NETCDF_FLOAT: init_cond_file_name = “init_cond.nc”

    • ASCII: init_cond_file_name = {“CB” : “cb.in”, “PL” : “pl.in”, “TP” : “tp.in”}

  • init_cond_format ({“EL”, “XV”}) – Indicates whether the input initial conditions are given as orbital elements or cartesian position and velocity vectors. If codename is “Swift” or “Swifter”, EL initial conditions are converted to XV.

  • **kwargs (Any) – A dictionary of additional keyword argument. This allows this method to be called by the more general set_parameter method, which takes all possible Simulation parameters as arguments, so these are ignored.

Returns:

init_cond_file_dict (dict) – A dictionary containing the requested parameters

Contents