/*******************************************************************************
 * This file is part of SWIFT.
 * Copyright (c) 2016 Matthieu Schaller (schaller@strw.leidenuniv.nl)
 *               2018 Folkert Nobels (nobels@strw.leidenuniv.nl)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 ******************************************************************************/
#ifndef SWIFT_EAGLE_STARS_IO_H
#define SWIFT_EAGLE_STARS_IO_H

#include "io_properties.h"
#include "kick.h"
#include "stars_part.h"

/**
 * @brief Specifies which s-particle fields to read from a dataset
 *
 * @param sparts The s-particle array.
 * @param list The list of i/o properties to read.
 * @param num_fields The number of i/o fields to read.
 */
INLINE static void stars_read_particles(struct spart *sparts,
                                        struct io_props *list,
                                        int *num_fields) {
  /* Say how much we want to read */
  *num_fields = 9;

  /* List what we want to read */
  list[0] = io_make_input_field("Coordinates", DOUBLE, 3, COMPULSORY,
                                UNIT_CONV_LENGTH, sparts, x);
  list[1] = io_make_input_field("Velocities", FLOAT, 3, COMPULSORY,
                                UNIT_CONV_SPEED, sparts, v);
  list[2] = io_make_input_field("Masses", FLOAT, 1, COMPULSORY, UNIT_CONV_MASS,
                                sparts, mass);
  list[3] = io_make_input_field("ParticleIDs", LONGLONG, 1, COMPULSORY,
                                UNIT_CONV_NO_UNITS, sparts, id);
  list[4] = io_make_input_field("SmoothingLength", FLOAT, 1, OPTIONAL,
                                UNIT_CONV_LENGTH, sparts, h);
  list[5] = io_make_input_field("Masses", FLOAT, 1, COMPULSORY, UNIT_CONV_MASS,
                                sparts, mass_init);

  /* For the birth time, -1 means the stars remain inactive feedback-wise
     througout the run */
  const float default_birth_time = -1.f;
  list[6] = io_make_input_field_default("StellarFormationTime", FLOAT, 1,
                                        OPTIONAL, UNIT_CONV_NO_UNITS, sparts,
                                        birth_time, default_birth_time);
  list[7] = io_make_input_field("BirthDensities", FLOAT, 1, OPTIONAL,
                                UNIT_CONV_DENSITY, sparts, birth_density);
  list[8] =
      io_make_input_field("BirthTemperatures", FLOAT, 1, OPTIONAL,
                          UNIT_CONV_TEMPERATURE, sparts, birth_temperature);
}

INLINE static void convert_spart_pos(const struct engine *e,
                                     const struct spart *sp, double *ret) {
  const struct space *s = e->s;
  ret[0] = sp->x[0];
  ret[1] = sp->x[1];
  ret[2] = sp->x[2];
  if (e->s->with_zoom_region) zoom_unshift_pos(e->s, ret);
  if (s->periodic) {
    ret[0] = box_wrap(ret[0], 0.0, s->dim[0]);
    ret[1] = box_wrap(ret[1], 0.0, s->dim[1]);
    ret[2] = box_wrap(ret[2], 0.0, s->dim[2]);
  }
  if (e->snapshot_use_delta_from_edge) {
    ret[0] = min(ret[0], s->dim[0] - e->snapshot_delta_from_edge);
    ret[1] = min(ret[1], s->dim[1] - e->snapshot_delta_from_edge);
    ret[2] = min(ret[2], s->dim[2] - e->snapshot_delta_from_edge);
  }
}

INLINE static void convert_spart_vel(const struct engine *e,
                                     const struct spart *sp, float *ret) {
  const int with_cosmology = (e->policy & engine_policy_cosmology);
  const struct cosmology *cosmo = e->cosmology;
  const integertime_t ti_current = e->ti_current;
  const double time_base = e->time_base;
  const float dt_kick_grav_mesh = e->dt_kick_grav_mesh_for_io;

  const integertime_t ti_beg = get_integer_time_begin(ti_current, sp->time_bin);
  const integertime_t ti_end = get_integer_time_end(ti_current, sp->time_bin);

  /* Get time-step since the last kick */
  const float dt_kick_grav =
      kick_get_grav_kick_dt(ti_beg, ti_current, time_base, with_cosmology,
                            cosmo) -
      kick_get_grav_kick_dt(ti_beg, (ti_beg + ti_end) / 2, time_base,
                            with_cosmology, cosmo);

  /* Extrapolate the velocites to the current time */
  const struct gpart *gp = sp->gpart;
  ret[0] = gp->v_full[0] + gp->a_grav[0] * dt_kick_grav;
  ret[1] = gp->v_full[1] + gp->a_grav[1] * dt_kick_grav;
  ret[2] = gp->v_full[2] + gp->a_grav[2] * dt_kick_grav;

  /* Extrapolate the velocites to the current time (mesh forces) */
  ret[0] += gp->a_grav_mesh[0] * dt_kick_grav_mesh;
  ret[1] += gp->a_grav_mesh[1] * dt_kick_grav_mesh;
  ret[2] += gp->a_grav_mesh[2] * dt_kick_grav_mesh;

  /* Conversion from internal units to peculiar velocities */
  ret[0] *= cosmo->a_inv;
  ret[1] *= cosmo->a_inv;
  ret[2] *= cosmo->a_inv;
}

INLINE static void convert_spart_luminosities(const struct engine *e,
                                              const struct spart *sp,
                                              float *ret) {
  stars_get_luminosities(sp, e->policy & engine_policy_cosmology, e->cosmology,
                         e->time, e->physical_constants, e->stars_properties,
                         ret);
}

INLINE static void convert_spart_potential(const struct engine *e,
                                           const struct spart *sp, float *ret) {

  if (sp->gpart != NULL)
    ret[0] = gravity_get_comoving_potential(sp->gpart);
  else
    ret[0] = 0.f;
}

/**
 * @brief Specifies which s-particle fields to write to a dataset
 *
 * @param sparts The s-particle array.
 * @param list The list of i/o properties to write.
 * @param num_fields The number of i/o fields to write.
 * @param with_cosmology Are we running a cosmological simulation?
 */
INLINE static void stars_write_particles(const struct spart *sparts,
                                         struct io_props *list, int *num_fields,
                                         const int with_cosmology) {
  /* Say how much we want to write */
  *num_fields = 14;

  /* List what we want to write */
  list[0] = io_make_output_field_convert_spart(
      "Coordinates", DOUBLE, 3, UNIT_CONV_LENGTH, 1.f, sparts,
      convert_spart_pos, "Co-moving position of the particles");

  list[1] = io_make_output_field_convert_spart(
      "Velocities", FLOAT, 3, UNIT_CONV_SPEED, 0.f, sparts, convert_spart_vel,
      "Peculiar velocities of the particles. This is a * dx/dt where x is the "
      "co-moving position of the particles.");

  list[2] = io_make_output_field("Masses", FLOAT, 1, UNIT_CONV_MASS, 0.f,
                                 sparts, mass,
                                 "Masses of the particles at the current point "
                                 "in time (i.e. after stellar losses");

  list[3] = io_make_physical_output_field(
      "ParticleIDs", ULONGLONG, 1, UNIT_CONV_NO_UNITS, 0.f, sparts, id,
      /*can convert to comoving=*/0, "Unique ID of the particles");

  list[4] = io_make_output_field(
      "SmoothingLengths", FLOAT, 1, UNIT_CONV_LENGTH, 1.f, sparts, h,
      "Co-moving smoothing lengths (FWHM of the kernel) of the particles");

  list[5] = io_make_output_field("InitialMasses", FLOAT, 1, UNIT_CONV_MASS, 0.f,
                                 sparts, mass_init,
                                 "Masses of the star particles at birth time");

  if (with_cosmology) {
    list[6] = io_make_physical_output_field(
        "BirthScaleFactors", FLOAT, 1, UNIT_CONV_NO_UNITS, 0.f, sparts,
        birth_scale_factor, /*can convert to comoving=*/0,
        "Scale-factors at which the stars were born");
  } else {
    list[6] = io_make_output_field("BirthTimes", FLOAT, 1, UNIT_CONV_TIME, 0.f,
                                   sparts, birth_time,
                                   "Times at which the stars were born");
  }

  list[7] = io_make_output_field(
      "FeedbackEnergyFractions", FLOAT, 1, UNIT_CONV_NO_UNITS, 0.f, sparts, f_E,
      "Fractions of the canonical feedback energy that was used for the stars' "
      "SNII feedback events");

  list[8] = io_make_output_field(
      "NumberOfFeedbackEvents", INT, 1, UNIT_CONV_NO_UNITS, 0.f, sparts,
      number_of_SNII_events,
      "Number of SNII energy injection events the stars went through.");

  list[9] = io_make_physical_output_field(
      "BirthDensities", FLOAT, 1, UNIT_CONV_DENSITY, -3.f, sparts,
      birth_density, /*can convert to comoving=*/0,
      "Physical densities at the time of birth of the gas particles that "
      "turned into stars (note that we store the physical density at the birth "
      "redshift, no conversion is needed)");

  list[10] = io_make_physical_output_field(
      "BirthTemperatures", FLOAT, 1, UNIT_CONV_TEMPERATURE, 0.f, sparts,
      birth_temperature, /*can convert to comoving=*/0,
      "Temperatures at the time of birth of the gas "
      "particles that turned into stars");

  list[11] = io_make_output_field(
      "FeedbackNumberOfHeatingEvents", FLOAT, 1, UNIT_CONV_NO_UNITS, 0.f,
      sparts, number_of_heating_events,
      "Expected number of particles that were heated by each star particle.");

  list[12] = io_make_output_field_convert_spart(
      "Luminosities", FLOAT, luminosity_bands_count, UNIT_CONV_NO_UNITS, 0.f,
      sparts, convert_spart_luminosities,
      "Rest-frame dust-free AB-luminosities of the star particles in the GAMA "
      "bands. These were computed using the BC03 (GALAXEV) models convolved "
      "with different filter bands and interpolated in log-log (f(log(Z), "
      "log(age)) = log(flux)) as used in the dust-free modelling of Trayford "
      "et al. (2015). The luminosities are given in dimensionless units. They "
      "have been divided by 3631 Jy already, i.e. they can be turned into "
      "absolute AB-magnitudes (rest-frame absolute maggies) directly by "
      "applying -2.5 log10(L) without additional corrections.");

  list[13] = io_make_output_field_convert_spart(
      "Potentials", FLOAT, 1, UNIT_CONV_POTENTIAL, -1.f, sparts,
      convert_spart_potential, "Gravitational potentials of the particles");
}

/**
 * @brief Initialize the global properties of the stars scheme.
 *
 * By default, takes the values provided by the hydro.
 *
 * @param sp The #stars_props.
 * @param phys_const The physical constants in the internal unit system.
 * @param us The internal unit system.
 * @param params The parsed parameters.
 * @param p The already read-in properties of the hydro scheme.
 * @param cosmo The cosmological model.
 */
INLINE static void stars_props_init(struct stars_props *sp,
                                    const struct phys_const *phys_const,
                                    const struct unit_system *us,
                                    struct swift_params *params,
                                    const struct hydro_props *p,
                                    const struct cosmology *cosmo) {
  /* Kernel properties */
  sp->eta_neighbours = parser_get_opt_param_float(
      params, "Stars:resolution_eta", p->eta_neighbours);

  /* Tolerance for the smoothing length Newton-Raphson scheme */
  sp->h_tolerance =
      parser_get_opt_param_float(params, "Stars:h_tolerance", p->h_tolerance);

  /* Get derived properties */
  sp->target_neighbours = pow_dimension(sp->eta_neighbours) * kernel_norm;
  const float delta_eta = sp->eta_neighbours * (1.f + sp->h_tolerance);
  sp->delta_neighbours =
      (pow_dimension(delta_eta) - pow_dimension(sp->eta_neighbours)) *
      kernel_norm;

  /* Number of iterations to converge h */
  sp->max_smoothing_iterations = parser_get_opt_param_int(
      params, "Stars:max_ghost_iterations", p->max_smoothing_iterations);

  /* Time integration properties */
  const float max_volume_change =
      parser_get_opt_param_float(params, "Stars:max_volume_change", -1);
  if (max_volume_change == -1)
    sp->log_max_h_change = p->log_max_h_change;
  else
    sp->log_max_h_change = logf(powf(max_volume_change, hydro_dimension_inv));

  /* Do we want to overwrite the stars' birth properties? */
  sp->overwrite_birth_time =
      parser_get_opt_param_int(params, "Stars:overwrite_birth_time", 0);
  sp->overwrite_birth_density =
      parser_get_opt_param_int(params, "Stars:overwrite_birth_density", 0);
  sp->overwrite_birth_temperature =
      parser_get_opt_param_int(params, "Stars:overwrite_birth_temperature", 0);

  /* Read birth time to set all stars in ICs */
  if (sp->overwrite_birth_time) {
    sp->spart_first_init_birth_time =
        parser_get_param_float(params, "Stars:birth_time");
  }

  /* Read birth density to set all stars in ICs */
  if (sp->overwrite_birth_density) {
    sp->spart_first_init_birth_density =
        parser_get_param_float(params, "Stars:birth_density");
  }

  /* Read birth temperature to set all stars in ICs */
  if (sp->overwrite_birth_temperature) {
    sp->spart_first_init_birth_temperature =
        parser_get_param_float(params, "Stars:birth_temperature");
  }

  /* Maximal time-step lengths */
  const double Myr = 1e6 * 365.25 * 24. * 60. * 60.;
  const double conv_fac = units_cgs_conversion_factor(us, UNIT_CONV_TIME);

  const double max_time_step_young_Myr = parser_get_opt_param_float(
      params, "Stars:max_timestep_young_Myr", FLT_MAX);
  const double max_time_step_old_Myr =
      parser_get_opt_param_float(params, "Stars:max_timestep_old_Myr", FLT_MAX);
  const double age_threshold_Myr = parser_get_opt_param_float(
      params, "Stars:timestep_age_threshold_Myr", FLT_MAX);
  const double age_threshold_unlimited_Myr = parser_get_opt_param_float(
      params, "Stars:timestep_age_threshold_unlimited_Myr", 0.);

  /* Check for consistency */
  if (age_threshold_unlimited_Myr != 0. && age_threshold_Myr != FLT_MAX) {
    if (age_threshold_unlimited_Myr < age_threshold_Myr)
      error(
          "The age threshold for unlimited stellar time-step sizes (%e Myr) is "
          "smaller than the transition threshold from young to old ages (%e "
          "Myr)",
          age_threshold_unlimited_Myr, age_threshold_Myr);
  }

  /* Convert to internal units */
  sp->max_time_step_young = max_time_step_young_Myr * Myr / conv_fac;
  sp->max_time_step_old = max_time_step_old_Myr * Myr / conv_fac;
  sp->age_threshold = age_threshold_Myr * Myr / conv_fac;
  sp->age_threshold_unlimited = age_threshold_unlimited_Myr * Myr / conv_fac;

  /* Read luminosity table filepath  */
  char base_dir_name[200];
  parser_get_param_string(params, "Stars:luminosity_filename", base_dir_name);

  static const char *luminosity_band_names[luminosity_bands_count] = {
      "u", "g", "r", "i", "z", "Y", "J", "H", "K"};

  /* Luminosity tables */
  for (int i = 0; i < (int)luminosity_bands_count; ++i) {
    const int count_Z = eagle_stars_lum_tables_N_Z;
    const int count_ages = eagle_stars_lum_tables_N_ages;
    const int count_L = count_Z * count_ages;

    sp->lum_tables_Z[i] = (float *)malloc(count_Z * sizeof(float));
    sp->lum_tables_ages[i] = (float *)malloc(count_ages * sizeof(float));
    sp->lum_tables_luminosities[i] = (float *)malloc(count_L * sizeof(float));

    char fname[256];
    sprintf(fname, "%s/GAMA/%s", base_dir_name, luminosity_band_names[i]);
    FILE *file = fopen(fname, "r");

    if (file != NULL) {
      char buffer[200];
      int j = 0, k = 0;
      while (fgets(buffer, sizeof(buffer), file) != NULL) {
        double z, age, L;
        sscanf(buffer, "%le %le %le", &z, &age, &L);

        if (age == 0.) {
          sp->lum_tables_Z[i][k++] = log10(z);
        }

        if (j < count_ages) {
          sp->lum_tables_ages[i][j] = log10(age + FLT_MIN);
        }

        sp->lum_tables_luminosities[i][j] = log10(L);

        ++j;
      }
    } else {
      error("Unable to load luminosity table %s", fname);
    }

    fclose(file);
  }

  /* Luminosity conversion factor */
  const double L_sun = 3.828e26;      /* Watt */
  const double pc = 3.08567758149e16; /* m */
  const double A = 4. * M_PI * (10. * pc) * (10 * pc);
  const double to_Jansky = 1e26 * L_sun / A;
  const double zero_point_AB = 3631; /* Jansky */
  sp->lum_tables_factor = to_Jansky / zero_point_AB;
}

/**
 * @brief Print the global properties of the stars scheme.
 *
 * @param sp The #stars_props.
 */
INLINE static void stars_props_print(const struct stars_props *sp) {
  message("Stars kernel: %s with eta=%f (%.2f neighbours).", kernel_name,
          sp->eta_neighbours, sp->target_neighbours);

  message("Stars relative tolerance in h: %.5f (+/- %.4f neighbours).",
          sp->h_tolerance, sp->delta_neighbours);

  message(
      "Stars integration: Max change of volume: %.2f "
      "(max|dlog(h)/dt|=%f).",
      pow_dimension(expf(sp->log_max_h_change)), sp->log_max_h_change);

  message("Maximal iterations in ghost task set to %d",
          sp->max_smoothing_iterations);

  if (sp->overwrite_birth_time)
    message("Stars' birth time read from the ICs will be overwritten to %f",
            sp->spart_first_init_birth_time);

  message("Stars' age threshold for unlimited dt: %e [U_t]",
          sp->age_threshold_unlimited);
  message("Stars' young/old age threshold: %e [U_t]", sp->age_threshold);
  message("Max time-step size of young stars: %e [U_t]",
          sp->max_time_step_young);
  message("Max time-step size of old stars: %e [U_t]", sp->max_time_step_old);
}

#if defined(HAVE_HDF5)
INLINE static void stars_props_print_snapshot(hid_t h_grpstars,
                                              hid_t h_grp_columns,
                                              const struct stars_props *sp) {
  io_write_attribute_s(h_grpstars, "Kernel function", kernel_name);
  io_write_attribute_f(h_grpstars, "Kernel target N_ngb",
                       sp->target_neighbours);
  io_write_attribute_f(h_grpstars, "Kernel delta N_ngb", sp->delta_neighbours);
  io_write_attribute_f(h_grpstars, "Kernel eta", sp->eta_neighbours);
  io_write_attribute_f(h_grpstars, "Smoothing length tolerance",
                       sp->h_tolerance);
  io_write_attribute_f(h_grpstars, "Volume log(max(delta h))",
                       sp->log_max_h_change);
  io_write_attribute_f(h_grpstars, "Volume max change time-step",
                       pow_dimension(expf(sp->log_max_h_change)));
  io_write_attribute_i(h_grpstars, "Max ghost iterations",
                       sp->max_smoothing_iterations);

  static const char luminosity_band_names[luminosity_bands_count][32] = {
      "GAMA_u", "GAMA_g", "GAMA_r", "GAMA_i", "GAMA_z",
      "GAMA_Y", "GAMA_J", "GAMA_H", "GAMA_K"};

  /* Add to the named columns */
  hsize_t dims[1] = {luminosity_bands_count};
  hid_t type = H5Tcopy(H5T_C_S1);
  H5Tset_size(type, 32);
  hid_t space = H5Screate_simple(1, dims, NULL);
  hid_t dset = H5Dcreate(h_grp_columns, "Luminosities", type, space,
                         H5P_DEFAULT, H5P_DEFAULT, H5P_DEFAULT);
  H5Dwrite(dset, type, H5S_ALL, H5S_ALL, H5P_DEFAULT, luminosity_band_names[0]);
  H5Dclose(dset);

  H5Tclose(type);
  H5Sclose(space);
}
#endif

/**
 * @brief Free the memory allocated for the stellar properties.
 *
 * @param sp The #stars_props structure.
 */
INLINE static void stars_props_clean(struct stars_props *sp) {
  for (int i = 0; i < (int)luminosity_bands_count; ++i) {
    free(sp->lum_tables_Z[i]);
    free(sp->lum_tables_ages[i]);
    free(sp->lum_tables_luminosities[i]);
  }
}

/**
 * @brief Write a #stars_props struct to the given FILE as a stream of bytes.
 *
 * @param p the struct
 * @param stream the file stream
 */
INLINE static void stars_props_struct_dump(struct stars_props *p,
                                           FILE *stream) {
  restart_write_blocks((void *)p, sizeof(struct stars_props), 1, stream,
                       "starsprops", "stars props");

  const int count_Z = eagle_stars_lum_tables_N_Z;
  const int count_ages = eagle_stars_lum_tables_N_ages;
  const int count_L = count_Z * count_ages;

  /* Did we allocate anything? */
  if (p->lum_tables_Z[0]) {
    for (int i = 0; i < (int)luminosity_bands_count; ++i) {
      restart_write_blocks(p->lum_tables_Z[i], count_Z, sizeof(float), stream,
                           "luminosity_Z", "stars props");
      restart_write_blocks(p->lum_tables_ages[i], count_ages, sizeof(float),
                           stream, "luminosity_ages", "stars props");
      restart_write_blocks(p->lum_tables_luminosities[i], count_L,
                           sizeof(float), stream, "luminosity_L",
                           "stars props");
    }
  }
}

/**
 * @brief Restore a stars_props struct from the given FILE as a stream of
 * bytes.
 *
 * @param p the struct
 * @param stream the file stream
 */
INLINE static void stars_props_struct_restore(struct stars_props *p,
                                              FILE *stream) {
  restart_read_blocks((void *)p, sizeof(struct stars_props), 1, stream, NULL,
                      "stars props");

  /* Did we allocate anything? */
  if (p->lum_tables_Z[0]) {
    for (int i = 0; i < (int)luminosity_bands_count; ++i) {
      const int count_Z = eagle_stars_lum_tables_N_Z;
      const int count_ages = eagle_stars_lum_tables_N_ages;
      const int count_L = count_Z * count_ages;

      p->lum_tables_Z[i] = (float *)malloc(count_Z * sizeof(float));
      p->lum_tables_ages[i] = (float *)malloc(count_ages * sizeof(float));
      p->lum_tables_luminosities[i] = (float *)malloc(count_L * sizeof(float));

      restart_read_blocks((void *)p->lum_tables_Z[i], count_Z, sizeof(float),
                          stream, NULL, "stars props");
      restart_read_blocks((void *)p->lum_tables_ages[i], count_ages,
                          sizeof(float), stream, NULL, "stars props");
      restart_read_blocks((void *)p->lum_tables_luminosities[i], count_L,
                          sizeof(float), stream, NULL, "stars props");
    }
  }
}

#endif /* SWIFT_EAGLE_STAR_IO_H */
