Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
SWIFT
SWIFTsim
Commits
d5382fa8
Commit
d5382fa8
authored
Feb 21, 2013
by
Matthieu Schaller
Browse files
Updated some documentation comments.
Former-commit-id: bd0147b2e56580c84d2ac7d5ae67f10590aef0fd
parent
df48ee60
Changes
7
Hide whitespace changes
Inline
Side-by-side
doc/Doxyfile
View file @
d5382fa8
...
...
@@ -527,7 +527,7 @@ LAYOUT_FILE =
# The QUIET tag can be used to turn on/off the messages that are generated
# by doxygen. Possible values are YES and NO. If left blank NO is used.
QUIET =
NO
QUIET =
YES
# The WARNINGS tag can be used to turn on/off the warning messages that are
# generated by doxygen. Possible values are YES and NO. If left blank
...
...
src/engine.c
View file @
d5382fa8
...
...
@@ -58,7 +58,6 @@
* @brief Prepare the #engine by re-building the cells and tasks.
*
* @param e The #engine to prepare.
* @param force Flag to force re-building the cell and task structure.
*/
void
engine_prepare
(
struct
engine
*
e
)
{
...
...
src/io.c
View file @
d5382fa8
...
...
@@ -522,7 +522,8 @@ void writeArrayBackEnd(hid_t grp, char* fileName, FILE* xmfFile, char* name, enu
* @param type The #DATA_TYPE of the array.
* @param N The number of particles to write.
* @param dim The dimension of the data (1 for scalar, 3 for vector)
* @param part_c A (char*) pointer on the first occurence of the field of interest in the parts array
* @param part A (char*) pointer on the first occurence of the field of interest in the parts array
* @param field The name (code name) of the field to read from.
*
*/
#define writeArray(grp, fileName, xmfFile, name, type, N, dim, part, field) writeArrayBackEnd(grp, fileName, xmfFile, name, type, N, dim, (char*)(&(part[0]).field))
...
...
src/runner.c
View file @
d5382fa8
...
...
@@ -164,6 +164,7 @@ void runner_dosort_ascending ( struct entry *sort , int N ) {
*
* @param r The #runner.
* @param c The #cell.
* @param flags Cell flag.
*/
void
runner_dosort
(
struct
runner
*
r
,
struct
cell
*
c
,
int
flags
)
{
...
...
@@ -319,7 +320,7 @@ void runner_dosort ( struct runner *r , struct cell *c , int flags ) {
* @brief Intermediate task between density and force
*
* @param r The runner thread.
* @param c
i
THe cell.
* @param c THe cell.
*/
void
runner_doghost
(
struct
runner
*
r
,
struct
cell
*
c
)
{
...
...
src/runner_doiact.h
View file @
d5382fa8
...
...
@@ -513,10 +513,9 @@ void DOPAIR_SUBSET ( struct runner *r , struct cell *restrict ci , struct part *
*
* @param r The #runner.
* @param ci The first #cell.
* @param parts
_i
The #parts to interact
with @c cj
.
* @param parts The #parts to interact.
* @param ind The list of indices of particles in @c ci to interact with.
* @param count The number of particles in @c ind.
* @param cj The second #cell.
*/
void
DOSELF_SUBSET
(
struct
runner
*
r
,
struct
cell
*
restrict
ci
,
struct
part
*
restrict
parts
,
int
*
restrict
ind
,
int
count
)
{
...
...
@@ -1602,9 +1601,11 @@ void DOSELF2 ( struct runner *r , struct cell *restrict c ) {
* @brief Compute grouped sub-cell interactions
*
* @param r The #runner.
* @param c The #cell.
* @param ci The first #cell.
* @param cj The second #cell.
* @param sid
*
*
TODO:
Hard-code the sid on the recursive calls to avoid the
*
@todo
Hard-code the sid on the recursive calls to avoid the
* redundant computations to find the sid on-the-fly.
*/
...
...
src/space.c
View file @
d5382fa8
...
...
@@ -334,7 +334,7 @@ int space_getsid ( struct space *s , struct cell **ci , struct cell **cj , doubl
/**
* @br
e
if Recursively dismantle a cell tree.
* @bri
e
f Recursively dismantle a cell tree.
*
*/
...
...
@@ -353,7 +353,7 @@ void space_rebuild_recycle ( struct space *s , struct cell *c ) {
}
/**
* @br
e
if Recursively rebuild a cell tree.
* @bri
e
f Recursively rebuild a cell tree.
*
*/
...
...
@@ -461,10 +461,10 @@ int space_rebuild_recurse ( struct space *s , struct cell *c ) {
}
/**
* @br
e
if Re-build the cells as well as the tasks.
* @bri
e
f Re-build the cells as well as the tasks.
*
* @param s The #space in which to update the cells.
* @param
force Flag to force re-building the cells and tasks
.
* @param
cell_max Maximal cell size
.
*
*/
...
...
@@ -736,6 +736,8 @@ void space_map_mkghosts ( struct cell *c , void *data ) {
* @brief Map a function to all particles in a aspace.
*
* @param s The #space we are working in.
* @param fun Function pointer to apply on the cells.
* @param data Data passed to the function fun.
*/
void
space_map_parts
(
struct
space
*
s
,
void
(
*
fun
)(
struct
part
*
p
,
struct
cell
*
c
,
void
*
data
)
,
void
*
data
)
{
...
...
@@ -771,6 +773,8 @@ void space_map_parts ( struct space *s , void (*fun)( struct part *p , struct ce
*
* @param s The #space we are working in.
* @param full Map to all cells, including cells with sub-cells.
* @param fun Function pointer to apply on the cells.
* @param data Data passed to the function fun.
*/
void
space_map_cells_post
(
struct
space
*
s
,
int
full
,
void
(
*
fun
)(
struct
cell
*
c
,
void
*
data
)
,
void
*
data
)
{
...
...
@@ -831,6 +835,13 @@ void space_map_cells_pre ( struct space *s , int full , void (*fun)( struct cell
* @brief Add a #task to the #space.
*
* @param s The #space we are working in.
* @param type The type of the task.
* @param subtype The sub-type of the task.
* @param flags The flags of the task.
* @param wait
* @param ci The first cell to interact.
* @param cj The second cell to interact.
* @param tight
*/
struct
task
*
space_addtask
(
struct
space
*
s
,
int
type
,
int
subtype
,
int
flags
,
int
wait
,
struct
cell
*
ci
,
struct
cell
*
cj
,
int
tight
)
{
...
...
@@ -1140,6 +1151,10 @@ void space_splittasks ( struct space *s ) {
* @brief Generate the sorts for a sub recursively.
*
* @param s The #space we are working in.
* @param t The #task.
* @param ci The first cell.
* @param cj The second cell.
* @param sid The sort ID.
*/
void
space_addsorts
(
struct
space
*
s
,
struct
task
*
t
,
struct
cell
*
ci
,
struct
cell
*
cj
,
int
sid
)
{
...
...
@@ -1676,11 +1691,12 @@ struct cell *space_getcell ( struct space *s ) {
/**
* @brief Split the space into cells given the array of particles.
*
* @param The #space to initialize.
* @param
s
The #space to initialize.
* @param dim Spatial dimensions of the domain.
* @param parts Pointer to an array of #part.
* @param N The number of parts in the space.
* @param periodic flag whether the domain is periodic or not.
* @param h_max The maximal interaction radius.
*
* Makes a grid of edge length > r_max and fills the particles
* into the respective cells. Cells containing more than #space_maxppc
...
...
src/task.c
View file @
d5382fa8
...
...
@@ -45,7 +45,7 @@ const char *taskID_names[task_type_count] = { "none" , "sort" , "self" , "pair"
/**
* @br
e
if Remove all unlocks to tasks that are of the given type.
* @bri
e
f Remove all unlocks to tasks that are of the given type.
*
* @param t The #task.
* @param type The task type ID to remove.
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment