engine.h 14.03 KiB
/*******************************************************************************
* This file is part of SWIFT.
* Copyright (c) 2012 Pedro Gonnet (pedro.gonnet@durham.ac.uk)
* Matthieu Schaller (matthieu.schaller@durham.ac.uk)
* 2015 Peter W. Draper (p.w.draper@durham.ac.uk)
* Angus Lepper (angus.lepper@ed.ac.uk)
* 2016 John A. Regan (john.a.regan@durham.ac.uk)
* Tom Theuns (tom.theuns@durham.ac.uk)
*
* 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_ENGINE_H
#define SWIFT_ENGINE_H
/* Config parameters. */
#include "../config.h"
/* MPI headers. */
#ifdef WITH_MPI
#include <mpi.h>
#endif
/* Includes. */
#include "barrier.h"
#include "chemistry_struct.h"
#include "clocks.h"
#include "collectgroup.h"
#include "cooling_struct.h"
#include "dump.h"
#include "gravity_properties.h"
#include "mesh_gravity.h"
#include "parser.h"
#include "partition.h"
#include "potential.h"
#include "runner.h"
#include "scheduler.h"
#include "sourceterms_struct.h"
#include "space.h"
#include "task.h"
#include "units.h"
#include "velociraptor_interface.h"
/**
* @brief The different policies the #engine can follow.
*/
enum engine_policy {
engine_policy_none = 0,
engine_policy_rand = (1 << 0),
engine_policy_steal = (1 << 1),
engine_policy_keep = (1 << 2),
engine_policy_block = (1 << 3),
engine_policy_cputight = (1 << 4),
engine_policy_mpi = (1 << 5),
engine_policy_setaffinity = (1 << 6),
engine_policy_hydro = (1 << 7),
engine_policy_self_gravity = (1 << 8),
engine_policy_external_gravity = (1 << 9),
engine_policy_cosmology = (1 << 10), engine_policy_drift_all = (1 << 11),
engine_policy_reconstruct_mpoles = (1 << 12),
engine_policy_cooling = (1 << 13),
engine_policy_sourceterms = (1 << 14),
engine_policy_stars = (1 << 15),
engine_policy_structure_finding = (1 << 16),
engine_policy_star_formation = (1 << 17),
engine_policy_feedback = (1 << 18)
};
#define engine_maxpolicy 19
extern const char *engine_policy_names[engine_maxpolicy + 1];
/**
* @brief The different unusual events that can take place in a time-step.
*/
enum engine_step_properties {
engine_step_prop_none = 0,
engine_step_prop_rebuild = (1 << 0),
engine_step_prop_redistribute = (1 << 1),
engine_step_prop_repartition = (1 << 2),
engine_step_prop_statistics = (1 << 3),
engine_step_prop_snapshot = (1 << 4),
engine_step_prop_restarts = (1 << 5),
engine_step_prop_logger_index = (1 << 6)
};
/* Some constants */
#define engine_maxproxies 64
#define engine_tasksreweight 1
#define engine_parts_size_grow 1.05
#define engine_max_proxy_centre_frac 0.2
#define engine_redistribute_alloc_margin 1.2
#define engine_default_energy_file_name "energy"
#define engine_default_timesteps_file_name "timesteps"
#define engine_max_parts_per_ghost 1000
#define engine_max_sparts_per_ghost 1000
/**
* @brief The rank of the engine as a global variable (for messages).
*/
extern int engine_rank;
/* Data structure for the engine. */
struct engine {
/* Number of threads on which to run. */
int nr_threads;
/* The space with which the runner is associated. */
struct space *s;
/* The runner's threads. */
struct runner *runners;
/* The running policy. */
int policy;
/* The task scheduler. */
struct scheduler sched;
/* Common threadpool for all the engine's tasks. */
struct threadpool threadpool;
/* The minimum and maximum allowed dt */
double dt_min, dt_max;
/* Maximum time-step allowed by the RMS condition in cosmology runs. */
double dt_max_RMS_displacement;
/* Dimensionless factor for the RMS time-step condition. */ double max_RMS_displacement_factor;
/* Time of the simulation beginning */
double time_begin;
/* Time of the simulation end */
double time_end;
/* The previous system time. */
double time_old;
integertime_t ti_old;
/* The current system time. */
double time;
integertime_t ti_current;
/* The highest active bin at this time */
timebin_t max_active_bin;
/* The lowest active bin at this time */
timebin_t min_active_bin;
/* Time step */
double time_step;
/* Time base */
double time_base;
double time_base_inv;
/* Minimal hydro ti_end for the next time-step */
integertime_t ti_hydro_end_min;
/* Maximal hydro ti_end for the next time-step */
integertime_t ti_hydro_end_max;
/* Maximal hydro ti_beg for the next time-step */
integertime_t ti_hydro_beg_max;
/* Minimal gravity ti_end for the next time-step */
integertime_t ti_gravity_end_min;
/* Maximal gravity ti_end for the next time-step */
integertime_t ti_gravity_end_max;
/* Maximal gravity ti_beg for the next time-step */
integertime_t ti_gravity_beg_max;
/* Minimal overall ti_end for the next time-step */
integertime_t ti_end_min;
/* Maximal overall ti_end for the next time-step */
integertime_t ti_end_max;
/* Maximal overall ti_beg for the next time-step */
integertime_t ti_beg_max;
/* Number of particles updated in the previous step */
long long updates, g_updates, s_updates;
/* Number of updates since the last rebuild */
long long updates_since_rebuild;
long long g_updates_since_rebuild;
long long s_updates_since_rebuild;
/* Properties of the previous step */
int step_props;
/* Total numbers of particles in the system. */
long long total_nr_parts, total_nr_gparts, total_nr_sparts;
/* The total number of inhibted particles in the system. */
long long nr_inhibited_parts, nr_inhibited_gparts, nr_inhibited_sparts;
#ifdef SWIFT_DEBUG_CHECKS
/* Total number of particles removed from the system since the last rebuild */
long long count_inhibited_parts, count_inhibited_gparts,
count_inhibited_sparts;
#endif
/* Total mass in the simulation */
double total_mass;
/* The internal system of units */
const struct unit_system *internal_units;
/* Top-level cell locations for VELOCIraptor. */
struct cell_loc *cell_loc;
/* Snapshot information */
double a_first_snapshot;
double time_first_snapshot;
double delta_time_snapshot;
/* Output_List for the snapshots */
struct output_list *output_list_snapshots;
/* Integer time of the next snapshot */
integertime_t ti_next_snapshot;
char snapshot_base_name[PARSER_MAX_LINE_SIZE];
int snapshot_compression;
int snapshot_int_time_label_on;
struct unit_system *snapshot_units;
int snapshot_output_count;
/* Structure finding information */
enum io_stf_output_format stf_output_freq_format;
int delta_step_stf;
double a_first_stf_output;
double time_first_stf_output;
double delta_time_stf;
/* Output_List for the structure finding */
struct output_list *output_list_stf;
/* Integer time of the next stf output */
integertime_t ti_next_stf;
char stfBaseName[PARSER_MAX_LINE_SIZE];
/* Statistics information */
double a_first_statistics;
double time_first_statistics;
double delta_time_statistics;
/* Output_List for the stats */
struct output_list *output_list_stats;
/* Integer time of the next statistics dump */
integertime_t ti_next_stats;
/* File handle for the statistics */
FILE *file_stats;
/* File handle for the timesteps information */
FILE *file_timesteps;
/* The current step number. */
int step;
/* Data for the threads' barrier. */
swift_barrier_t wait_barrier;
swift_barrier_t run_barrier;
/* ID of the node this engine lives on. */
int nr_nodes, nodeID;
/* Proxies for the other nodes in this simulation. */
struct proxy *proxies;
int nr_proxies, *proxy_ind;
#ifdef SWIFT_DEBUG_TASKS
/* Tic/toc at the start/end of a step. */
ticks tic_step, toc_step;
#endif
#ifdef WITH_MPI
/* CPU time of the last step. */
double cputime_last_step;
/* Step of last repartition. */
int last_repartition;
#endif
/* Wallclock time of the last time-step */
float wallclock_time;
/* Are we in the process of restaring a simulation? */
int restarting;
/* Force the engine to rebuild? */
int forcerebuild;
/* Force the engine to repartition ? */
int forcerepart;
struct repartition *reparttype;
#ifdef WITH_LOGGER
struct logger *logger;
#endif
/* How many steps have we done with the same set of tasks? */
int tasks_age;
/* Linked list for cell-task association. */
struct link *links;
size_t nr_links, size_links;
/* Average number of tasks per cell. Used to estimate the sizes
* of the various task arrays. */
size_t tasks_per_cell;
/* Are we talkative ? */
int verbose;
/* Physical constants definition */
const struct phys_const *physical_constants;
/* The cosmological model */
struct cosmology *cosmology;
/* Properties of the hydro scheme */
const struct hydro_props *hydro_properties;
/* Properties of the star model */
const struct stars_props *stars_properties;
/* Properties of the self-gravity scheme */
struct gravity_props *gravity_properties;
/* The mesh used for long-range gravity forces */
struct pm_mesh *mesh;
/* Properties of external gravitational potential */
const struct external_potential *external_potential;
/* Properties of the cooling scheme */
const struct cooling_function_data *cooling_func;
/* Properties of the chemistry model */
const struct chemistry_global_data *chemistry;
/* Properties of source terms */
struct sourceterms *sourceterms;
/* The (parsed) parameter file */
struct swift_params *parameter_file;
/* Temporary struct to hold a group of deferable properties (in MPI mode
* these are reduced together, but may not be required just yet). */
struct collectgroup1 collect_group1;
/* Whether to dump restart files. */
int restart_dump;
/* Whether to save previous generation of restart files. */
int restart_save;
/* Whether to dump restart files after the last step. */
int restart_onexit;
/* Name of the restart file. */
const char *restart_file;
/* Ticks between restart dumps. */
ticks restart_dt;
/* Time after which next dump will occur. */
ticks restart_next;
/* Maximum number of tasks needed for restarting. */
int restart_max_tasks;
};
/* Function prototypes, engine.c. */
void engine_addlink(struct engine *e, struct link **l, struct task *t);
void engine_barrier(struct engine *e);
void engine_compute_next_snapshot_time(struct engine *e);
void engine_compute_next_stf_time(struct engine *e);
void engine_compute_next_statistics_time(struct engine *e);
void engine_recompute_displacement_constraint(struct engine *e);
void engine_unskip(struct engine *e);
void engine_drift_all(struct engine *e);
void engine_drift_top_multipoles(struct engine *e);
void engine_reconstruct_multipoles(struct engine *e);
void engine_print_stats(struct engine *e);
void engine_check_for_dumps(struct engine *e);
void engine_dump_snapshot(struct engine *e);
void engine_init_output_lists(struct engine *e, struct swift_params *params);
void engine_init(struct engine *e, struct space *s, struct swift_params *params,
long long Ngas, long long Ngparts, long long Nstars,
int policy, int verbose, struct repartition *reparttype,
const struct unit_system *internal_units,
const struct phys_const *physical_constants,
struct cosmology *cosmo, const struct hydro_props *hydro,
struct gravity_props *gravity, const struct stars_props *stars,
struct pm_mesh *mesh,
const struct external_potential *potential,
const struct cooling_function_data *cooling_func,
const struct chemistry_global_data *chemistry, struct sourceterms *sourceterms);
void engine_config(int restart, struct engine *e, struct swift_params *params,
int nr_nodes, int nodeID, int nr_threads, int with_aff,
int verbose, const char *restart_file);
void engine_dump_index(struct engine *e);
void engine_launch(struct engine *e);
void engine_prepare(struct engine *e);
void engine_init_particles(struct engine *e, int flag_entropy_ICs,
int clean_h_values);
void engine_step(struct engine *e);
void engine_split(struct engine *e, struct partition *initial_partition);
void engine_exchange_strays(struct engine *e, const size_t offset_parts,
const int *ind_part, size_t *Npart,
const size_t offset_gparts, const int *ind_gpart,
size_t *Ngpart, const size_t offset_sparts,
const int *ind_spart, size_t *Nspart);
void engine_rebuild(struct engine *e, int redistributed, int clean_h_values);
void engine_repartition(struct engine *e);
void engine_repartition_trigger(struct engine *e);
void engine_makeproxies(struct engine *e);
void engine_redistribute(struct engine *e);
void engine_print_policy(struct engine *e);
int engine_is_done(struct engine *e);
void engine_pin(void);
void engine_unpin(void);
void engine_clean(struct engine *e);
int engine_estimate_nr_tasks(struct engine *e);
/* Function prototypes, engine_maketasks.c. */
void engine_maketasks(struct engine *e);
/* Function prototypes, engine_marktasks.c. */
int engine_marktasks(struct engine *e);
#ifdef HAVE_SETAFFINITY
cpu_set_t *engine_entry_affinity(void);
#endif
/* Struct dump/restore support. */
void engine_struct_dump(struct engine *e, FILE *stream);
void engine_struct_restore(struct engine *e, FILE *stream);
void engine_dump_restarts(struct engine *e, int drifted_all, int final_step);
#endif /* SWIFT_ENGINE_H */