Commit 0409f121 authored by Matthieu Schaller's avatar Matthieu Schaller
Browse files

Documentation improvements

parent 9008b444
......@@ -19,6 +19,12 @@
#ifndef SWIFT_ADIABATIC_INDEX_H
#define SWIFT_ADIABATIC_INDEX_H
/**
* @file adiabatic_index.h
* @brief Defines the adiabatic index (polytropix index) \f$\gamma\f$ of the
* problem and (fast) mathematical functions involving it.
*/
/* Config parameters. */
#include "../config.h"
......
......@@ -19,6 +19,12 @@
#ifndef SWIFT_DIMENSION_H
#define SWIFT_DIMENSION_H
/**
* @file dimension.h
* @brief Defines the dimensionality \f$d\f$ of the problem and (fast)
* mathematical functions involving it
*/
/* Config parameters. */
#include "../config.h"
......
......@@ -20,9 +20,21 @@
#ifndef SWIFT_KERNEL_HYDRO_H
#define SWIFT_KERNEL_HYDRO_H
/**
* @file kernel_hydro.h
* @brief Kernel functions for SPH (scalar and vector version).
*
* All constants and kernel coefficients are taken from table 1 of
* Dehnen & Aly, MNRAS, 425, pp. 1062-1082 (2012).
*/
/* Config parameters. */
#include "../config.h"
/* Some standard headers. */
#include <math.h>
/* Includes. */
/* Local headers. */
#include "const.h"
#include "dimension.h"
#include "error.h"
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment