Commit 1bfcfaf6 authored by James Willis's avatar James Willis
Browse files

Updated comments.

parent a766a9a2
...@@ -438,8 +438,7 @@ static const vector cond = FILL_VEC(0.5f); ...@@ -438,8 +438,7 @@ static const vector cond = FILL_VEC(0.5f);
/** /**
* @brief Computes the kernel function and its derivative for two particles * @brief Computes the kernel function and its derivative for two particles
* using vectors. Does not return zero if $u > \\gamma = H/h$, should only * using vectors. The return value is undefined if $u > \\gamma = H/h$.
* be called if particles are known to interact.
* *
* @param u The ratio of the distance to the smoothing length $u = x/h$. * @param u The ratio of the distance to the smoothing length $u = x/h$.
* @param w (return) The value of the kernel function $W(x,h)$. * @param w (return) The value of the kernel function $W(x,h)$.
...@@ -517,10 +516,8 @@ __attribute__((always_inline)) INLINE static void kernel_deval_1_vec( ...@@ -517,10 +516,8 @@ __attribute__((always_inline)) INLINE static void kernel_deval_1_vec(
/** /**
* @brief Computes the kernel function and its derivative for two particles * @brief Computes the kernel function and its derivative for two particles
* using interleaved vectors. Does not return zero if $u > \\gamma = H/h$, * using interleaved vectors. The return value is undefined if $u > \\gamma = H/h$.
* should only *
* be called if particles are known to interact.
*
* @param u The ratio of the distance to the smoothing length $u = x/h$. * @param u The ratio of the distance to the smoothing length $u = x/h$.
* @param w (return) The value of the kernel function $W(x,h)$. * @param w (return) The value of the kernel function $W(x,h)$.
* @param dw_dx (return) The norm of the gradient of $|\\nabla W(x,h)|$. * @param dw_dx (return) The norm of the gradient of $|\\nabla W(x,h)|$.
...@@ -643,8 +640,7 @@ __attribute__((always_inline)) INLINE static void kernel_deval_2_vec( ...@@ -643,8 +640,7 @@ __attribute__((always_inline)) INLINE static void kernel_deval_2_vec(
/** /**
* @brief Computes the kernel function for two particles * @brief Computes the kernel function for two particles
* using vectors. Does not return zero if $u > \\gamma = H/h$, should only * using vectors. The return value is undefined if $u > \\gamma = H/h$.
* be called if particles are known to interact.
* *
* @param u The ratio of the distance to the smoothing length $u = x/h$. * @param u The ratio of the distance to the smoothing length $u = x/h$.
* @param w (return) The value of the kernel function $W(x,h)$. * @param w (return) The value of the kernel function $W(x,h)$.
...@@ -704,8 +700,7 @@ __attribute__((always_inline)) INLINE static void kernel_eval_W_vec(vector *u, ...@@ -704,8 +700,7 @@ __attribute__((always_inline)) INLINE static void kernel_eval_W_vec(vector *u,
/** /**
* @brief Computes the kernel function derivative for two particles * @brief Computes the kernel function derivative for two particles
* using vectors. Does not return zero if $u > \\gamma = H/h$, should only * using vectors. The return value is undefined if $u > \\gamma = H/h$.
* be called if particles are known to interact.
* *
* @param u The ratio of the distance to the smoothing length $u = x/h$. * @param u The ratio of the distance to the smoothing length $u = x/h$.
* @param dw_dx (return) The norm of the gradient of $|\\nabla W(x,h)|$. * @param dw_dx (return) The norm of the gradient of $|\\nabla W(x,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