[SCM] Gerris Flow Solver branch, upstream, updated. b3aa46814a06c9cb2912790b23916ffb44f1f203
Stephane Popinet
popinet at users.sf.net
Fri May 15 02:53:30 UTC 2009
The following commit has been merged in the upstream branch:
commit a22d62e5b42100cd53d16c42adf4ce30fa8cee73
Author: Stephane Popinet <popinet at users.sf.net>
Date: Wed Feb 21 07:51:05 2007 +1100
Updated source doc templates
darcs-hash:20070220205105-d4795-abdf78c030a18a1b9108752ed3154a4bbe96ff5c.gz
diff --git a/doc/tmpl/advection.sgml b/doc/tmpl/advection.sgml
index a3437ff..2337065 100644
--- a/doc/tmpl/advection.sgml
+++ b/doc/tmpl/advection.sgml
@@ -33,6 +33,7 @@ Advection scheme
@upwinding:
@flux:
@scheme:
+ at average:
<!-- ##### FUNCTION gfs_advection_params_init ##### -->
<para>
@@ -78,8 +79,6 @@ Advection scheme
@upwinding:
@u:
@Returns:
-<!-- # Unused Parameters # -->
- at centered_upwinding:
<!-- ##### FUNCTION gfs_face_advection_flux ##### -->
@@ -116,8 +115,6 @@ Advection scheme
@face:
@par:
-<!-- # Unused Parameters # -->
- at upwinding:
<!-- ##### FUNCTION gfs_face_interpolated_normal_velocity ##### -->
diff --git a/doc/tmpl/box.sgml b/doc/tmpl/box.sgml
index f742371..a44cfb3 100644
--- a/doc/tmpl/box.sgml
+++ b/doc/tmpl/box.sgml
@@ -101,7 +101,6 @@ Fluid box
</para>
- at box:
@Returns:
diff --git a/doc/tmpl/diffusion.sgml b/doc/tmpl/diffusion.sgml
index ae0665a..cb0c2ec 100644
--- a/doc/tmpl/diffusion.sgml
+++ b/doc/tmpl/diffusion.sgml
@@ -27,8 +27,6 @@ Diffusion solver
@rhs:
@dia:
@beta:
-<!-- # Unused Parameters # -->
- at cell:
<!-- ##### FUNCTION gfs_diffusion_residual ##### -->
@@ -41,9 +39,6 @@ Diffusion solver
@rhs:
@dia:
@res:
-<!-- # Unused Parameters # -->
- at cell:
- at v:
<!-- ##### FUNCTION gfs_diffusion_coefficients ##### -->
diff --git a/doc/tmpl/domain-advection-vof.sgml b/doc/tmpl/domain-advection-vof.sgml
index a35fd3c..8d2672d 100644
--- a/doc/tmpl/domain-advection-vof.sgml
+++ b/doc/tmpl/domain-advection-vof.sgml
@@ -68,8 +68,6 @@ Volume of Fluid advection
@alpha:
@a:
@p:
-<!-- # Unused Parameters # -->
- at c:
<!-- ##### FUNCTION gfs_cell_vof_advection ##### -->
diff --git a/doc/tmpl/domain-advection.sgml b/doc/tmpl/domain-advection.sgml
index 5e1cb26..b825cdf 100644
--- a/doc/tmpl/domain-advection.sgml
+++ b/doc/tmpl/domain-advection.sgml
@@ -73,9 +73,6 @@ Advection
@apar:
@g:
@alpha:
-<!-- # Unused Parameters # -->
- at dpar:
- at par:
<!-- ##### FUNCTION gfs_tracer_advection_diffusion ##### -->
@@ -86,8 +83,6 @@ Advection
@domain:
@par:
@half:
-<!-- # Unused Parameters # -->
- at dpar:
<!-- ##### FUNCTION gfs_predicted_face_velocities ##### -->
diff --git a/doc/tmpl/domain.sgml b/doc/tmpl/domain.sgml
index c26381a..c9b0be9 100644
--- a/doc/tmpl/domain.sgml
+++ b/doc/tmpl/domain.sgml
@@ -107,6 +107,7 @@ Fluid domain
@domain:
@name:
+ at description:
@Returns:
@@ -116,7 +117,7 @@ Fluid domain
</para>
@domain:
- at v:
+ at info:
@Returns:
@@ -379,8 +380,6 @@ Fluid domain
@fp:
@Returns:
-<!-- # Unused Parameters # -->
- at domain:
<!-- ##### FUNCTION gfs_domain_split ##### -->
diff --git a/doc/tmpl/fluid.sgml b/doc/tmpl/fluid.sgml
index efe0f3f..d9b940a 100644
--- a/doc/tmpl/fluid.sgml
+++ b/doc/tmpl/fluid.sgml
@@ -91,6 +91,7 @@ The fluid variables associated with a fluid cell.
@i:
@component:
@name:
+ at description:
@centered:
@fine_coarse:
@coarse_fine:
@@ -186,11 +187,8 @@ The fluid variables associated with a fluid cell.
@klass:
@domain:
@name:
+ at description:
@Returns:
-<!-- # Unused Parameters # -->
- at parent:
- at centered:
- at i:
<!-- ##### FUNCTION gfs_variable_from_name ##### -->
@@ -201,8 +199,6 @@ The fluid variables associated with a fluid cell.
@i:
@name:
@Returns:
-<!-- # Unused Parameters # -->
- at variables:
<!-- ##### FUNCTION gfs_variables_from_list ##### -->
@@ -214,8 +210,6 @@ The fluid variables associated with a fluid cell.
@list:
@error:
@Returns:
-<!-- # Unused Parameters # -->
- at variables:
<!-- ##### FUNCTION gfs_stats_variable ##### -->
@@ -228,8 +222,6 @@ The fluid variables associated with a fluid cell.
@flags:
@max_depth:
@Returns:
-<!-- # Unused Parameters # -->
- at level:
<!-- ##### FUNCTION gfs_norm_variable ##### -->
@@ -242,8 +234,6 @@ The fluid variables associated with a fluid cell.
@flags:
@max_depth:
@Returns:
-<!-- # Unused Parameters # -->
- at level:
<!-- ##### FUNCTION gfs_get_from_below_intensive ##### -->
@@ -271,8 +261,6 @@ The fluid variables associated with a fluid cell.
@cell:
@domain:
-<!-- # Unused Parameters # -->
- at variables:
<!-- ##### FUNCTION gfs_cell_fine_init ##### -->
@@ -282,8 +270,6 @@ The fluid variables associated with a fluid cell.
@cell:
@domain:
-<!-- # Unused Parameters # -->
- at variables:
<!-- ##### FUNCTION gfs_vector_norm ##### -->
@@ -373,8 +359,6 @@ Defines the (second-order accurate) gradient of a variable @v in a given directi
@g:
@v:
@max_level:
-<!-- # Unused Parameters # -->
- at Returns:
<!-- ##### FUNCTION gfs_face_weighted_gradient ##### -->
@@ -538,8 +522,6 @@ Defines the (second-order accurate) gradient of a variable @v in a given directi
@cell:
@fp:
@domain:
-<!-- # Unused Parameters # -->
- at variables:
<!-- ##### FUNCTION gfs_cell_read_binary ##### -->
diff --git a/doc/tmpl/ftt-basic.sgml b/doc/tmpl/ftt-basic.sgml
index 28640fb..d7ebf05 100644
--- a/doc/tmpl/ftt-basic.sgml
+++ b/doc/tmpl/ftt-basic.sgml
@@ -180,8 +180,6 @@ This function is used to control the refinement process of a cell tree.
@cleanup:
@cleanup_data:
@Returns:
-<!-- # Unused Parameters # -->
- at data:
<!-- ##### FUNCTION ftt_cell_flatten ##### -->
@@ -303,16 +301,6 @@ Evaluates to the level of @c.
</para>
- at level:
- at Returns:
-
-
-<!-- ##### FUNCTION ftt_cell_size ##### -->
-<para>
-
-</para>
-
- at cell:
@Returns:
@@ -321,7 +309,6 @@ Evaluates to the level of @c.
</para>
- at cell:
@Returns:
diff --git a/doc/tmpl/ftt-face.sgml b/doc/tmpl/ftt-face.sgml
index ea0b9d4..a2af8d2 100644
--- a/doc/tmpl/ftt-face.sgml
+++ b/doc/tmpl/ftt-face.sgml
@@ -49,7 +49,6 @@ Cell faces operations
</para>
@cell:
- at d:
@Returns:
@@ -58,7 +57,6 @@ Cell faces operations
</para>
- at face:
@Returns:
diff --git a/doc/tmpl/ftt-other.sgml b/doc/tmpl/ftt-other.sgml
index 6a14b4d..8ee04f5 100644
--- a/doc/tmpl/ftt-other.sgml
+++ b/doc/tmpl/ftt-other.sgml
@@ -131,7 +131,6 @@ This functions is called by ftt_cell_traverse() for each of the visited cells.
</para>
- at t:
@Returns:
@@ -194,8 +193,6 @@ Writes in @fp any user data associated with @cell. It is important that this fun
@read:
@data:
@Returns:
-<!-- # Unused Parameters # -->
- at line:
<!-- ##### FUNCTION ftt_cell_read_binary ##### -->
diff --git a/doc/tmpl/ftt-topology.sgml b/doc/tmpl/ftt-topology.sgml
index 66d9727..67e79aa 100644
--- a/doc/tmpl/ftt-topology.sgml
+++ b/doc/tmpl/ftt-topology.sgml
@@ -54,7 +54,6 @@ Evaluates to the child index of @c.
</para>
@cell:
- at children:
<!-- ##### STRUCT FttCellChildren ##### -->
@@ -91,7 +90,6 @@ Evaluates to the child index of @c.
@cell:
@d:
- at children:
@Returns:
@@ -101,7 +99,6 @@ Evaluates to the child index of @c.
</para>
@cell:
- at Param2:
@Returns:
@@ -111,7 +108,6 @@ Evaluates to the child index of @c.
</para>
@cell:
- at neighbors:
<!-- ##### FUNCTION ftt_cell_neighbors_not_cached ##### -->
@@ -120,7 +116,6 @@ Evaluates to the child index of @c.
</para>
@cell:
- at neighbors:
<!-- ##### STRUCT FttCellNeighbors ##### -->
@@ -136,7 +131,6 @@ Evaluates to the child index of @c.
</para>
@cell:
- at d:
@Returns:
@@ -146,7 +140,6 @@ Evaluates to the child index of @c.
</para>
@cell:
- at d:
@Returns:
@@ -180,7 +173,6 @@ Evaluates to the child index of @c.
</para>
@cell:
- at d:
@Returns:
diff --git a/doc/tmpl/function.sgml b/doc/tmpl/function.sgml
index 972e1f3..244a8e6 100644
--- a/doc/tmpl/function.sgml
+++ b/doc/tmpl/function.sgml
@@ -105,8 +105,6 @@ or a C expression
@f:
@fa:
@Returns:
-<!-- # Unused Parameters # -->
- at t:
<!-- ##### FUNCTION gfs_function_value ##### -->
@@ -117,9 +115,6 @@ or a C expression
@f:
@cell:
@Returns:
-<!-- # Unused Parameters # -->
- at p:
- at t:
<!-- ##### FUNCTION gfs_function_read ##### -->
diff --git a/doc/tmpl/gfs-unused.sgml b/doc/tmpl/gfs-unused.sgml
index 1f81fb4..b22e6e0 100644
--- a/doc/tmpl/gfs-unused.sgml
+++ b/doc/tmpl/gfs-unused.sgml
@@ -484,6 +484,14 @@ Evaluates to the index of the neighboring direction opposite to @i.
@cell:
@v:
+<!-- ##### FUNCTION ftt_cell_size ##### -->
+<para>
+
+</para>
+
+ at cell:
+ at Returns:
+
<!-- ##### FUNCTION gfs_boundary_inflow_class ##### -->
<para>
diff --git a/doc/tmpl/output.sgml b/doc/tmpl/output.sgml
index 1f3f512..ad93bd8 100644
--- a/doc/tmpl/output.sgml
+++ b/doc/tmpl/output.sgml
@@ -115,6 +115,7 @@ which will convert the PPM stream generated by #GfsOutputPPM directly to MPEG us
@refcount:
@name:
@fp:
+ at is_pipe:
<!-- ##### FUNCTION gfs_output_class ##### -->
<para>
diff --git a/doc/tmpl/poisson.sgml b/doc/tmpl/poisson.sgml
index 42bfd81..d8dd443 100644
--- a/doc/tmpl/poisson.sgml
+++ b/doc/tmpl/poisson.sgml
@@ -73,9 +73,6 @@ Poisson solver
@u:
@rhs:
@dia:
-<!-- # Unused Parameters # -->
- at root:
- at level:
<!-- ##### FUNCTION gfs_residual ##### -->
@@ -91,9 +88,6 @@ Poisson solver
@rhs:
@dia:
@res:
-<!-- # Unused Parameters # -->
- at root:
- at cell:
<!-- ##### FUNCTION gfs_poisson_coefficients ##### -->
@@ -103,10 +97,6 @@ Poisson solver
@domain:
@alpha:
-<!-- # Unused Parameters # -->
- at dia:
- at c:
- at rho:
<!-- ##### FUNCTION gfs_poisson_cycle ##### -->
@@ -120,11 +110,6 @@ Poisson solver
@rhs:
@dia:
@res:
-<!-- # Unused Parameters # -->
- at d:
- at levelmin:
- at depth:
- at nrelax:
<!-- ##### FUNCTION gfs_correct_normal_velocities ##### -->
@@ -138,9 +123,6 @@ Poisson solver
@g:
@dt:
@w:
-<!-- # Unused Parameters # -->
- at face:
- at par:
<!-- ##### FUNCTION gfs_mac_projection ##### -->
diff --git a/doc/tmpl/simulation.sgml b/doc/tmpl/simulation.sgml
index f9aa05f..bda5c49 100644
--- a/doc/tmpl/simulation.sgml
+++ b/doc/tmpl/simulation.sgml
@@ -69,6 +69,7 @@ Simulations
@events:
@modules:
@variables:
+ at globals:
@tnext:
<!-- ##### STRUCT GfsTime ##### -->
@@ -125,8 +126,6 @@ Simulations
@fp:
@Returns:
-<!-- # Unused Parameters # -->
- at sim:
<!-- ##### FUNCTION gfs_simulation_refine ##### -->
@@ -151,7 +150,6 @@ Simulations
</para>
@simulation:
- at s:
<!-- ##### FUNCTION gfs_simulation_write ##### -->
diff --git a/doc/tmpl/solid.sgml b/doc/tmpl/solid.sgml
index 3f16888..36736a3 100644
--- a/doc/tmpl/solid.sgml
+++ b/doc/tmpl/solid.sgml
@@ -77,11 +77,6 @@ Contains the surface and volume fractions of the cell not contained in the solid
@root:
@Returns:
-<!-- # Unused Parameters # -->
- at solid:
- at stree:
- at is_open:
- at s:
<!-- ##### FUNCTION gfs_cell_traverse_mixed ##### -->
--
Gerris Flow Solver
More information about the debian-science-commits
mailing list