[SCM] Gerris Flow Solver branch, upstream, updated. b3aa46814a06c9cb2912790b23916ffb44f1f203
Stephane Popinet
s.popinet at niwa.co.nz
Fri May 15 02:52:10 UTC 2009
The following commit has been merged in the upstream branch:
commit fb51fb3364a00a18d065a9bc2372c6cde0765800
Author: Stephane Popinet <s.popinet at niwa.co.nz>
Date: Mon Jul 4 13:23:09 2005 +1000
Updated reference doc
darcs-hash:20050704032309-fbd8f-a575b39fd95911b09a35b4205d04ed57f579f9c8.gz
diff --git a/doc/gfs-docs.sgml b/doc/gfs-docs.sgml
index 348d3aa..4e0bce8 100644
--- a/doc/gfs-docs.sgml
+++ b/doc/gfs-docs.sgml
@@ -26,6 +26,7 @@
<!entity gfs-event-script SYSTEM "sgml/event_script.sgml">
<!entity gfs-event-stop SYSTEM "sgml/event_stop.sgml">
<!entity gfs-event-sum SYSTEM "sgml/event_sum.sgml">
+<!entity gfs-event-harmonic SYSTEM "sgml/event_harmonic.sgml">
<!entity gfs-generic-init SYSTEM "sgml/generic_init.sgml">
<!entity gfs-init SYSTEM "sgml/init.sgml">
<!entity gfs-init-vorticity SYSTEM "sgml/init_vorticity.sgml">
@@ -36,18 +37,18 @@
<!entity gfs-output-diffusion SYSTEM "sgml/output_diffusion.sgml">
<!entity gfs-output-adapts SYSTEM "sgml/output_adapts.sgml">
<!entity gfs-output-timing SYSTEM "sgml/output_timing.sgml">
+<!entity gfs-output-progress SYSTEM "sgml/output_progress.sgml">
<!entity gfs-output-balance SYSTEM "sgml/output_balance.sgml">
<!entity gfs-output-solid SYSTEM "sgml/output_solid.sgml">
<!entity gfs-output-solid-force SYSTEM "sgml/output_solid_force.sgml">
<!entity gfs-output-simulation SYSTEM "sgml/output_simulation.sgml">
-<!entity gfs-output-boundaries SYSTEM "sgml/output_boundaries.sgml">
<!entity gfs-output-location SYSTEM "sgml/output_location.sgml">
<!entity gfs-output-scalar SYSTEM "sgml/output_scalar.sgml">
<!entity gfs-output-scalar-norm SYSTEM "sgml/output_scalar_norm.sgml">
<!entity gfs-output-scalar-stats SYSTEM "sgml/output_scalar_stats.sgml">
<!entity gfs-output-scalar-sum SYSTEM "sgml/output_scalar_sum.sgml">
+<!entity gfs-output-scalar-histogram SYSTEM "sgml/output_scalar_histogram.sgml">
<!entity gfs-output-error-norm SYSTEM "sgml/output_error_norm.sgml">
-<!entity gfs-output-squares SYSTEM "sgml/output_squares.sgml">
<!entity gfs-output-ppm SYSTEM "sgml/output_ppm.sgml">
<!entity gfs-refine SYSTEM "sgml/refine.sgml">
<!entity gfs-refine-solid SYSTEM "sgml/refine_solid.sgml">
@@ -56,6 +57,7 @@
<!entity gfs-simulation SYSTEM "sgml/simulation.sgml">
<!entity gfs-source-generic SYSTEM "sgml/source_generic.sgml">
<!entity gfs-source SYSTEM "sgml/source.sgml">
+<!entity gfs-source-tension SYSTEM "sgml/source_tension.sgml">
]>
<book>
@@ -124,6 +126,7 @@
<title>Source terms</title>
&gfs-source-generic;
&gfs-source;
+ &gfs-source-tension;
</sect1>
<sect1>
<title>Events</title>
@@ -131,6 +134,7 @@
&gfs-event-script;
&gfs-event-stop;
&gfs-event-sum;
+ &gfs-event-harmonic;
</sect1>
<sect1>
<title>Initialisation</title>
@@ -147,18 +151,18 @@
&gfs-output-diffusion;
&gfs-output-adapts;
&gfs-output-timing;
+ &gfs-output-progress;
&gfs-output-balance;
&gfs-output-solid;
&gfs-output-solid-force;
&gfs-output-location;
&gfs-output-simulation;
- &gfs-output-boundaries;
&gfs-output-scalar;
&gfs-output-scalar-norm;
&gfs-output-scalar-stats;
&gfs-output-scalar-sum;
+ &gfs-output-scalar-histogram;
&gfs-output-error-norm;
- &gfs-output-squares;
&gfs-output-ppm;
</sect1>
<sect1>
diff --git a/doc/gfs-sections.txt b/doc/gfs-sections.txt
index 4caaf5e..fd3c652 100644
--- a/doc/gfs-sections.txt
+++ b/doc/gfs-sections.txt
@@ -40,6 +40,7 @@ ftt_cell_size
ftt_cell_volume
ftt_cell_parent
ftt_cell_depth
+ftt_vector_norm
</SECTION>
<SECTION>
@@ -127,10 +128,6 @@ gfs_norm_reset
<TITLE>Fluid cell</TITLE>
GFS_VARIABLE
GFS_STATE
-GFS_VELOCITY_COMPONENT
-GFS_VELOCITY_INDEX
-GFS_GRADIENT_COMPONENT
-GFS_GRADIENT_INDEX
GFS_FACE_NORMAL_VELOCITY_RIGHT
GFS_FACE_NORMAL_VELOCITY_LEFT
GFS_FACE_NORMAL_VELOCITY
@@ -140,7 +137,6 @@ GFS_CELL_IS_BOUNDARY
GfsStateVector
GfsFaceStateVector
GfsVariable
-GfsPermanentVariable
GfsVariableClass
GfsVariableDerivedFunc
GfsVariableFineCoarseFunc
@@ -153,13 +149,8 @@ gfs_cell_copy
gfs_cell_cm
gfs_face_ca
gfs_variable_new
-gfs_variable_list_copy
-gfs_variable_list_destroy
-gfs_variable_source
gfs_variable_from_name
gfs_variables_from_list
-gfs_variable_parent
-gfs_variable_set_parent
gfs_stats_variable
gfs_norm_variable
gfs_get_from_below_intensive
@@ -167,8 +158,8 @@ gfs_get_from_below_extensive
gfs_get_from_above
gfs_cell_coarse_init
gfs_cell_fine_init
-gfs_velocity_norm
-gfs_velocity_norm2
+gfs_vector_norm
+gfs_vector_norm2
gfs_divergence
gfs_normal_divergence
gfs_vorticity
@@ -186,7 +177,6 @@ gfs_center_van_leer_gradient
gfs_cell_dirichlet_gradient
gfs_cell_dirichlet_gradient_flux
gfs_cell_dirichlet_value
-gfs_cell_laplacian
GfsInterpolator
gfs_cell_corner_interpolator
gfs_cell_corner_value
@@ -279,10 +269,8 @@ GFS_FACE_FRACTION
GfsSolidVector
<SUBSECTION>
gfs_cell_fluid
-gfs_cell_init_solid_fractions
gfs_cell_init_solid_fractions_from_children
gfs_cell_check_solid_fractions
-gfs_refine_mixed
gfs_cell_traverse_mixed
</SECTION>
@@ -297,16 +285,20 @@ GfsDomainClass
GfsDomain
<SUBSECTION>
gfs_domain_class
+gfs_domain_alloc
+gfs_domain_free
gfs_domain_add_variable
-gfs_domain_add_new_variable
-gfs_domain_replace_variable
+gfs_domain_add_derived_variable
gfs_domain_cell_traverse
gfs_domain_cell_traverse_boundary
gfs_domain_cell_traverse_box
gfs_domain_traverse_mixed
gfs_domain_face_traverse
+gfs_domain_combine_traverse
+gfs_domain_traverse_cut
gfs_domain_locate
gfs_domain_bc
+gfs_domain_copy_bc
gfs_domain_homogeneous_bc
gfs_domain_face_bc
gfs_domain_surface_bc
@@ -321,7 +313,6 @@ gfs_domain_solid_force
gfs_domain_init_fraction
gfs_domain_read
gfs_domain_split
-gfs_domain_variable_sources
gfs_domain_remove_droplets
gfs_domain_remove_ponds
gfs_domain_remove_specks
@@ -459,6 +450,28 @@ gfs_source_class
</SECTION>
<SECTION>
+<FILE>source_control</FILE>
+<TITLE>Controled source term</TITLE>
+GFS_SOURCE_CONTROL
+GFS_IS_SOURCE_CONTROL
+<SUBSECTION>
+GfsSourceControl
+<SUBSECTION>
+gfs_source_control_class
+</SECTION>
+
+<SECTION>
+<FILE>source_tension</FILE>
+<TITLE>Surface tension source term</TITLE>
+GFS_SOURCE_TENSION
+GFS_IS_SOURCE_TENSION
+<SUBSECTION>
+GfsSourceTension
+<SUBSECTION>
+gfs_source_tension_class
+</SECTION>
+
+<SECTION>
<FILE>adapt</FILE>
<TITLE>Simple refinement</TITLE>
GFS_ADAPT
@@ -504,6 +517,7 @@ GfsEvent
gfs_event_class
gfs_event_new
gfs_event_set
+gfs_event_is_repetitive
</SECTION>
<SECTION>
@@ -537,7 +551,12 @@ GFS_IS_EVENT_SUM
GfsEventSum
<SUBSECTION>
gfs_event_sum_class
-gfs_event_sum2_class
+</SECTION>
+
+<SECTION>
+<FILE>event_harmonic</FILE>
+<TITLE>Harmonic analysis events</TITLE>
+gfs_event_harmonic_class
</SECTION>
<SECTION>
@@ -556,6 +575,10 @@ gfs_function_face_value
gfs_function_value
gfs_function_read
gfs_function_write
+gfs_function_description
+gfs_function_get_constant_value
+gfs_function_set_constant_value
+gfs_function_get_variable
</SECTION>
<SECTION>
@@ -563,6 +586,9 @@ gfs_function_write
<TITLE>Generic initialisation event</TITLE>
GFS_IS_GENERIC_INIT
<SUBSECTION>
+GfsGenericInitClass
+GfsGenericInit
+<SUBSECTION>
gfs_generic_init_class
</SECTION>
@@ -650,6 +676,12 @@ gfs_output_timing_class
</SECTION>
<SECTION>
+<FILE>output_progress</FILE>
+<TITLE>Progress output</TITLE>
+gfs_output_progress_class
+</SECTION>
+
+<SECTION>
<FILE>output_balance</FILE>
<TITLE>Balance statistics output</TITLE>
gfs_output_balance_class
@@ -726,8 +758,16 @@ gfs_output_scalar_sum_class
</SECTION>
<SECTION>
+<FILE>output_scalar_histogram</FILE>
+<TITLE>Scalar histogram output</TITLE>
+gfs_output_scalar_histogram_class
+</SECTION>
+
+<SECTION>
<FILE>output_error_norm</FILE>
<TITLE>Error norm output</TITLE>
+GfsOutputErrorNorm
+<SUBSECTION>
gfs_output_error_norm_class
</SECTION>
@@ -765,8 +805,6 @@ gfs_refine_class
<TITLE>Solid refinement</TITLE>
GFS_IS_REFINE_SOLID
<SUBSECTION>
-GfsRefineSolid
-<SUBSECTION>
gfs_refine_solid_class
</SECTION>
@@ -809,9 +847,7 @@ gfs_simulation_class
gfs_simulation_new
gfs_simulation_read
gfs_simulation_refine
-gfs_simulation_event_init
gfs_simulation_set_timestep
-gfs_simulation_event
gfs_simulation_adapt
gfs_simulation_write
gfs_simulation_run
diff --git a/doc/tmpl/adapt.sgml b/doc/tmpl/adapt.sgml
index aa3ea97..401b10a 100644
--- a/doc/tmpl/adapt.sgml
+++ b/doc/tmpl/adapt.sgml
@@ -86,6 +86,8 @@ with
</para>
+ at minlevel:
+ at maxlevel:
@mincells:
@maxcells:
@cmax:
diff --git a/doc/tmpl/advection.sgml b/doc/tmpl/advection.sgml
index edf255e..2bfce31 100644
--- a/doc/tmpl/advection.sgml
+++ b/doc/tmpl/advection.sgml
@@ -21,6 +21,10 @@ Advection scheme
@cfl:
@dt:
+ at v:
+ at fv:
+ at u:
+ at g:
@gradient:
@use_centered_velocity:
@upwinding:
@@ -71,6 +75,7 @@ Advection scheme
@face:
@upwinding:
+ at u:
@Returns:
<!-- # Unused Parameters # -->
@centered_upwinding:
@@ -109,6 +114,8 @@ Advection scheme
</para>
@face:
+ at par:
+<!-- # Unused Parameters # -->
@upwinding:
@@ -118,6 +125,7 @@ Advection scheme
</para>
@face:
+ at v:
<!-- ##### FUNCTION gfs_face_reset_normal_velocity ##### -->
diff --git a/doc/tmpl/diffusion.sgml b/doc/tmpl/diffusion.sgml
index 015f5df..af10875 100644
--- a/doc/tmpl/diffusion.sgml
+++ b/doc/tmpl/diffusion.sgml
@@ -19,8 +19,12 @@ Diffusion solver
</para>
- at cell:
+ at domain:
@v:
+ at rhs:
+ at dia:
+<!-- # Unused Parameters # -->
+ at cell:
<!-- ##### FUNCTION gfs_diffusion_residual ##### -->
@@ -28,6 +32,12 @@ Diffusion solver
</para>
+ at domain:
+ at u:
+ at rhs:
+ at dia:
+ at res:
+<!-- # Unused Parameters # -->
@cell:
@v:
@@ -40,6 +50,7 @@ Diffusion solver
@domain:
@d:
@dt:
+ at dia:
<!-- ##### FUNCTION gfs_diffusion_cycle ##### -->
@@ -52,5 +63,8 @@ Diffusion solver
@depth:
@nrelax:
@u:
+ at rhs:
+ at dia:
+ at res:
diff --git a/doc/tmpl/domain-advection.sgml b/doc/tmpl/domain-advection.sgml
index 63adc2a..07bc6ab 100644
--- a/doc/tmpl/domain-advection.sgml
+++ b/doc/tmpl/domain-advection.sgml
@@ -67,8 +67,11 @@ Advection
@domain:
@dimension:
- at par:
+ at apar:
@dpar:
+ at g:
+<!-- # Unused Parameters # -->
+ at par:
<!-- ##### FUNCTION gfs_tracer_advection_diffusion ##### -->
diff --git a/doc/tmpl/domain.sgml b/doc/tmpl/domain.sgml
index 85d8f9c..c8fc320 100644
--- a/doc/tmpl/domain.sgml
+++ b/doc/tmpl/domain.sgml
@@ -63,8 +63,10 @@ Fluid domain
@rootlevel:
@refpos:
@lambda:
+ at allocated:
@variables:
- at variables_size:
+ at derived_variables:
+ at velocity:
@variables_io:
@binary:
@max_depth_write:
@@ -77,33 +79,42 @@ Fluid domain
@Returns:
-<!-- ##### FUNCTION gfs_domain_add_variable ##### -->
+<!-- ##### FUNCTION gfs_domain_alloc ##### -->
<para>
</para>
@domain:
- at name:
@Returns:
-<!-- ##### FUNCTION gfs_domain_add_new_variable ##### -->
+<!-- ##### FUNCTION gfs_domain_free ##### -->
<para>
</para>
@domain:
- at v:
+ at i:
-<!-- ##### FUNCTION gfs_domain_replace_variable ##### -->
+<!-- ##### FUNCTION gfs_domain_add_variable ##### -->
+<para>
+
+</para>
+
+ at domain:
+ at name:
+ at Returns:
+
+
+<!-- ##### FUNCTION gfs_domain_add_derived_variable ##### -->
<para>
</para>
@domain:
@v:
- at with:
+ at Returns:
<!-- ##### FUNCTION gfs_domain_cell_traverse ##### -->
@@ -173,6 +184,32 @@ Fluid domain
@data:
+<!-- ##### FUNCTION gfs_domain_combine_traverse ##### -->
+<para>
+
+</para>
+
+ at domain1:
+ at domain2:
+ at inside:
+ at idata:
+ at outside:
+ at odata:
+
+
+<!-- ##### FUNCTION gfs_domain_traverse_cut ##### -->
+<para>
+
+</para>
+
+ at domain:
+ at s:
+ at order:
+ at flags:
+ at func:
+ at data:
+
+
<!-- ##### FUNCTION gfs_domain_locate ##### -->
<para>
@@ -195,6 +232,18 @@ Fluid domain
@v:
+<!-- ##### FUNCTION gfs_domain_copy_bc ##### -->
+<para>
+
+</para>
+
+ at domain:
+ at flags:
+ at max_depth:
+ at v:
+ at v1:
+
+
<!-- ##### FUNCTION gfs_domain_homogeneous_bc ##### -->
<para>
diff --git a/doc/tmpl/event.sgml b/doc/tmpl/event.sgml
index 1bf1ab0..0f5363f 100644
--- a/doc/tmpl/event.sgml
+++ b/doc/tmpl/event.sgml
@@ -93,6 +93,7 @@ with
@parent_class:
@event:
+ at post_event:
@event_half:
<!-- ##### STRUCT GfsEvent ##### -->
@@ -144,3 +145,11 @@ with
@istep:
+<!-- ##### MACRO gfs_event_is_repetitive ##### -->
+<para>
+
+</para>
+
+ at e:
+
+
diff --git a/doc/tmpl/event_stop.sgml b/doc/tmpl/event_stop.sgml
index e0dbd8a..f8deb2c 100644
--- a/doc/tmpl/event_stop.sgml
+++ b/doc/tmpl/event_stop.sgml
@@ -45,6 +45,9 @@ where NAME is the name of a variable and MIN is the threshold.
</para>
@parent:
+ at v:
+ at oldv:
+ at diff:
@last:
@max:
diff --git a/doc/tmpl/event_sum.sgml b/doc/tmpl/event_sum.sgml
index f74acd2..d8f1cd0 100644
--- a/doc/tmpl/event_sum.sgml
+++ b/doc/tmpl/event_sum.sgml
@@ -6,7 +6,7 @@ Computing time-integrated fields
<!-- ##### SECTION Long_Description ##### -->
<para>
-GfsEventSum and GfsEventSum2 can be used to compute and store the sum and squared sum of a time-varying variable.
+GfsEventSum can be used to compute and store the sum over time of a variable.
</para>
<para>
The syntax in parameter files is as follows:
@@ -45,6 +45,8 @@ where V is an existing variable name and SV is a (possibly new) variable name wh
</para>
@parent:
+ at v:
+ at sv:
@sum:
@last:
@dt:
@@ -57,11 +59,3 @@ where V is an existing variable name and SV is a (possibly new) variable name wh
@Returns:
-<!-- ##### FUNCTION gfs_event_sum2_class ##### -->
-<para>
-
-</para>
-
- at Returns:
-
-
diff --git a/doc/tmpl/fluid.sgml b/doc/tmpl/fluid.sgml
index 96e8bf3..a221aab 100644
--- a/doc/tmpl/fluid.sgml
+++ b/doc/tmpl/fluid.sgml
@@ -31,42 +31,6 @@ Evaluates to the value of variable @index in @cell.
@cell:
-<!-- ##### MACRO GFS_VELOCITY_COMPONENT ##### -->
-<para>
-
-</para>
-
- at index:
-<!-- # Unused Parameters # -->
- at variable:
-
-
-<!-- ##### MACRO GFS_VELOCITY_INDEX ##### -->
-<para>
-
-</para>
-
- at component:
-
-
-<!-- ##### MACRO GFS_GRADIENT_COMPONENT ##### -->
-<para>
-
-</para>
-
- at index:
-<!-- # Unused Parameters # -->
- at variable:
-
-
-<!-- ##### MACRO GFS_GRADIENT_INDEX ##### -->
-<para>
-
-</para>
-
- at component:
-
-
<!-- ##### MACRO GFS_FACE_NORMAL_VELOCITY_RIGHT ##### -->
<para>
@@ -114,13 +78,7 @@ The fluid variables describing the state of the cell.
@f:
@solid:
- at div:
- at dp:
- at res:
- at g:
- at p:
- at u:
- at v:
+ at place_holder:
<!-- ##### STRUCT GfsFaceStateVector ##### -->
<para>
@@ -136,26 +94,14 @@ The fluid variables associated with a fluid cell.
</para>
@i:
+ at component:
@name:
@centered:
@derived:
@fine_coarse:
@sources:
@surface_bc:
- at p:
-
-<!-- ##### ENUM GfsPermanentVariable ##### -->
-<para>
-
-</para>
-
- at GFS_DIV:
- at GFS_DP:
- at GFS_RES:
- at GFS_GX:
- at GFS_GY:
- at GFS_U:
- at GFS_V:
+ at domain:
<!-- ##### STRUCT GfsVariableClass ##### -->
<para>
@@ -251,29 +197,13 @@ The fluid variables associated with a fluid cell.
</para>
@klass:
- at parent:
+ at domain:
@name:
- at centered:
- at i:
@Returns:
-
-
-<!-- ##### FUNCTION gfs_variable_list_copy ##### -->
-<para>
-
-</para>
-
- at v:
+<!-- # Unused Parameters # -->
@parent:
- at Returns:
-
-
-<!-- ##### FUNCTION gfs_variable_list_destroy ##### -->
-<para>
-
-</para>
-
- at v:
+ at centered:
+ at i:
<!-- ##### FUNCTION gfs_variable_from_name ##### -->
@@ -281,9 +211,11 @@ The fluid variables associated with a fluid cell.
</para>
- at variables:
+ at i:
@name:
@Returns:
+<!-- # Unused Parameters # -->
+ at variables:
<!-- ##### FUNCTION gfs_variables_from_list ##### -->
@@ -291,27 +223,12 @@ The fluid variables associated with a fluid cell.
</para>
- at variables:
+ at i:
@list:
@error:
@Returns:
-
-
-<!-- ##### MACRO gfs_variable_parent ##### -->
-<para>
-
-</para>
-
- at v:
-
-
-<!-- ##### MACRO gfs_variable_set_parent ##### -->
-<para>
-
-</para>
-
- at v:
- at pa:
+<!-- # Unused Parameters # -->
+ at variables:
<!-- ##### FUNCTION gfs_stats_variable ##### -->
@@ -391,22 +308,24 @@ The fluid variables associated with a fluid cell.
@variables:
-<!-- ##### FUNCTION gfs_velocity_norm ##### -->
+<!-- ##### FUNCTION gfs_vector_norm ##### -->
<para>
</para>
@cell:
@v:
+ at Returns:
-<!-- ##### FUNCTION gfs_velocity_norm2 ##### -->
+<!-- ##### FUNCTION gfs_vector_norm2 ##### -->
<para>
</para>
@cell:
@v:
+ at Returns:
<!-- ##### FUNCTION gfs_divergence ##### -->
@@ -416,6 +335,7 @@ The fluid variables associated with a fluid cell.
@cell:
@v:
+ at Returns:
<!-- ##### FUNCTION gfs_normal_divergence ##### -->
@@ -424,6 +344,7 @@ The fluid variables associated with a fluid cell.
</para>
@cell:
+ at v:
<!-- ##### FUNCTION gfs_vorticity ##### -->
@@ -433,6 +354,7 @@ The fluid variables associated with a fluid cell.
@cell:
@v:
+ at Returns:
<!-- ##### FUNCTION gfs_face_interpolated_value ##### -->
@@ -578,16 +500,6 @@ Defines the (second-order accurate) gradient of a variable @v in a given directi
@Returns:
-<!-- ##### FUNCTION gfs_cell_laplacian ##### -->
-<para>
-
-</para>
-
- at cell:
- at v:
- at Returns:
-
-
<!-- ##### STRUCT GfsInterpolator ##### -->
<para>
diff --git a/doc/tmpl/ftt-basic.sgml b/doc/tmpl/ftt-basic.sgml
index 4185175..7b0e00a 100644
--- a/doc/tmpl/ftt-basic.sgml
+++ b/doc/tmpl/ftt-basic.sgml
@@ -339,3 +339,11 @@ Evaluates to the parent of @c. %NULL is @c is a root cell.
@Returns:
+<!-- ##### MACRO ftt_vector_norm ##### -->
+<para>
+
+</para>
+
+ at v:
+
+
diff --git a/doc/tmpl/ftt-face.sgml b/doc/tmpl/ftt-face.sgml
index 86be548..4026f2b 100644
--- a/doc/tmpl/ftt-face.sgml
+++ b/doc/tmpl/ftt-face.sgml
@@ -36,6 +36,8 @@ Cell faces operations
</para>
+ at cell:
+ at neighbor:
@d:
<!-- ##### FUNCTION ftt_cell_face ##### -->
diff --git a/doc/tmpl/function.sgml b/doc/tmpl/function.sgml
index 6d80875..a3af36a 100644
--- a/doc/tmpl/function.sgml
+++ b/doc/tmpl/function.sgml
@@ -6,7 +6,7 @@ Values varying in space and time
<!-- ##### SECTION Long_Description ##### -->
<para>
-Functions can be used in most objects which require a numerical parameter. A function can be either a constant or a piece of C code taking coordinates (x,y,z) and time t as arguments and returning a floating-point value.
+Functions can be used in most objects which require a numerical parameter. A function can be either a constant or a piece of C code taking coordinates (x,y,z), time t or any of the domain variables as arguments and returning a floating-point value.
</para>
<para>
The syntax in parameter files is as follows:
@@ -26,6 +26,12 @@ or a C function
}
</programlisting>
</informalexample>
+or a C expression
+<informalexample>
+<programlisting>
+40.*(P - 1.)
+</programlisting>
+</informalexample>
</para>
<!-- ##### SECTION See_Also ##### -->
@@ -95,8 +101,9 @@ or a C function
@f:
@fa:
- at t:
@Returns:
+<!-- # Unused Parameters # -->
+ at t:
<!-- ##### FUNCTION gfs_function_value ##### -->
@@ -106,9 +113,10 @@ or a C function
@f:
@cell:
+ at Returns:
+<!-- # Unused Parameters # -->
@p:
@t:
- at Returns:
<!-- ##### FUNCTION gfs_function_read ##### -->
@@ -130,3 +138,40 @@ or a C function
@fp:
+<!-- ##### FUNCTION gfs_function_description ##### -->
+<para>
+
+</para>
+
+ at f:
+ at truncate:
+ at Returns:
+
+
+<!-- ##### FUNCTION gfs_function_get_constant_value ##### -->
+<para>
+
+</para>
+
+ at f:
+ at Returns:
+
+
+<!-- ##### FUNCTION gfs_function_set_constant_value ##### -->
+<para>
+
+</para>
+
+ at f:
+ at val:
+
+
+<!-- ##### FUNCTION gfs_function_get_variable ##### -->
+<para>
+
+</para>
+
+ at f:
+ at Returns:
+
+
diff --git a/doc/tmpl/generic_init.sgml b/doc/tmpl/generic_init.sgml
index 6de866f..3e1bd99 100644
--- a/doc/tmpl/generic_init.sgml
+++ b/doc/tmpl/generic_init.sgml
@@ -30,6 +30,18 @@ The syntax in parameter files is as follows:
@obj:
+<!-- ##### TYPEDEF GfsGenericInitClass ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### TYPEDEF GfsGenericInit ##### -->
+<para>
+
+</para>
+
+
<!-- ##### FUNCTION gfs_generic_init_class ##### -->
<para>
diff --git a/doc/tmpl/gfs-unused.sgml b/doc/tmpl/gfs-unused.sgml
index f684df7..1d4721e 100644
--- a/doc/tmpl/gfs-unused.sgml
+++ b/doc/tmpl/gfs-unused.sgml
@@ -210,6 +210,13 @@ Evaluates to the index of the neighboring direction opposite to @i.
@obj:
+<!-- ##### MACRO GFS_EVENT_HARMONIC ##### -->
+<para>
+
+</para>
+
+ at obj:
+
<!-- ##### MACRO GFS_GRADIENT ##### -->
<para>
@@ -217,6 +224,21 @@ Evaluates to the index of the neighboring direction opposite to @i.
@component:
+<!-- ##### MACRO GFS_GRADIENT_COMPONENT ##### -->
+<para>
+
+</para>
+
+ at index:
+ at variable:
+
+<!-- ##### MACRO GFS_GRADIENT_INDEX ##### -->
+<para>
+
+</para>
+
+ at component:
+
<!-- ##### MACRO GFS_INIT_FLOW_CONSTANT ##### -->
<para>
@@ -238,6 +260,13 @@ Evaluates to the index of the neighboring direction opposite to @i.
@obj:
+<!-- ##### MACRO GFS_IS_EVENT_HARMONIC ##### -->
+<para>
+
+</para>
+
+ at obj:
+
<!-- ##### MACRO GFS_IS_INIT_FLOW_CONSTANT ##### -->
<para>
@@ -294,6 +323,21 @@ Evaluates to the index of the neighboring direction opposite to @i.
@component:
+<!-- ##### MACRO GFS_VELOCITY_COMPONENT ##### -->
+<para>
+
+</para>
+
+ at index:
+ at variable:
+
+<!-- ##### MACRO GFS_VELOCITY_INDEX ##### -->
+<para>
+
+</para>
+
+ at component:
+
<!-- ##### STRUCT GfsBoundaryInflowClass ##### -->
<para>
@@ -323,6 +367,28 @@ Evaluates to the index of the neighboring direction opposite to @i.
@GFS_BOUNDARY_MATCH_VARIABLE:
@GFS_BOUNDARY_VARIABLE_NUMBER:
+<!-- ##### STRUCT GfsEventHarmonic ##### -->
+<para>
+
+</para>
+
+ at parent:
+ at omega:
+ at v:
+ at z:
+ at A:
+ at B:
+ at vsin:
+ at vcos:
+ at M:
+ at iM:
+ at Mn:
+ at x:
+ at a:
+ at Aname:
+ at Bname:
+ at invertible:
+
<!-- ##### STRUCT GfsInitFlowConstant ##### -->
<para>
@@ -330,6 +396,32 @@ Evaluates to the index of the neighboring direction opposite to @i.
@u:
+<!-- ##### STRUCT GfsOutputScalarHistogram ##### -->
+<para>
+
+</para>
+
+ at x:
+ at y:
+ at W:
+ at w:
+ at last:
+ at dt:
+ at n:
+
+<!-- ##### ENUM GfsPermanentVariable ##### -->
+<para>
+
+</para>
+
+ at GFS_DIV:
+ at GFS_DP:
+ at GFS_RES:
+ at GFS_GX:
+ at GFS_GY:
+ at GFS_U:
+ at GFS_V:
+
<!-- ##### STRUCT GfsProjectionParams ##### -->
<para>
@@ -430,6 +522,15 @@ Evaluates to the index of the neighboring direction opposite to @i.
@data:
@Param2:
+<!-- ##### FUNCTION gfs_cell_laplacian ##### -->
+<para>
+
+</para>
+
+ at cell:
+ at v:
+ at Returns:
+
<!-- ##### FUNCTION gfs_centered_velocity_advection ##### -->
<para>
@@ -473,6 +574,14 @@ Evaluates to the index of the neighboring direction opposite to @i.
@refine:
@refine_data:
+<!-- ##### FUNCTION gfs_domain_add_new_variable ##### -->
+<para>
+
+</para>
+
+ at domain:
+ at v:
+
<!-- ##### FUNCTION gfs_domain_center_bc ##### -->
<para>
@@ -501,6 +610,15 @@ Evaluates to the index of the neighboring direction opposite to @i.
@cleanup:
@data:
+<!-- ##### FUNCTION gfs_domain_replace_variable ##### -->
+<para>
+
+</para>
+
+ at domain:
+ at v:
+ at with:
+
<!-- ##### FUNCTION gfs_domain_traversed_merged ##### -->
<para>
@@ -528,6 +646,13 @@ Evaluates to the index of the neighboring direction opposite to @i.
@root:
@fp:
+<!-- ##### FUNCTION gfs_event_sum2_class ##### -->
+<para>
+
+</para>
+
+ at Returns:
+
<!-- ##### FUNCTION gfs_gradient ##### -->
<para>
@@ -706,6 +831,37 @@ Evaluates to the index of the neighboring direction opposite to @i.
@v:
+<!-- ##### FUNCTION gfs_variable_list_copy ##### -->
+<para>
+
+</para>
+
+ at v:
+ at parent:
+ at Returns:
+
+<!-- ##### FUNCTION gfs_variable_list_destroy ##### -->
+<para>
+
+</para>
+
+ at v:
+
+<!-- ##### MACRO gfs_variable_parent ##### -->
+<para>
+
+</para>
+
+ at v:
+
+<!-- ##### MACRO gfs_variable_set_parent ##### -->
+<para>
+
+</para>
+
+ at v:
+ at pa:
+
<!-- ##### FUNCTION gfs_variable_source ##### -->
<para>
@@ -715,6 +871,22 @@ Evaluates to the index of the neighboring direction opposite to @i.
@cell:
@Returns:
+<!-- ##### FUNCTION gfs_velocity_norm ##### -->
+<para>
+
+</para>
+
+ at cell:
+ at v:
+
+<!-- ##### FUNCTION gfs_velocity_norm2 ##### -->
+<para>
+
+</para>
+
+ at cell:
+ at v:
+
<!-- ##### FUNCTION gfs_velocity_sources ##### -->
<para>
diff --git a/doc/tmpl/init_vorticity.sgml b/doc/tmpl/init_vorticity.sgml
index 1de6578..c3e1e0e 100644
--- a/doc/tmpl/init_vorticity.sgml
+++ b/doc/tmpl/init_vorticity.sgml
@@ -54,6 +54,7 @@ The syntax in parameter files is as follows:
</para>
+ at f:
<!-- ##### STRUCT GfsInitVorticityClass ##### -->
<para>
diff --git a/doc/tmpl/output_error_norm.sgml b/doc/tmpl/output_error_norm.sgml
index ebc0f22..85d9c82 100644
--- a/doc/tmpl/output_error_norm.sgml
+++ b/doc/tmpl/output_error_norm.sgml
@@ -45,6 +45,14 @@ with
</para>
+<!-- ##### STRUCT GfsOutputErrorNorm ##### -->
+<para>
+
+</para>
+
+ at s:
+ at unbiased:
+
<!-- ##### FUNCTION gfs_output_error_norm_class ##### -->
<para>
diff --git a/doc/tmpl/output_scalar.sgml b/doc/tmpl/output_scalar.sgml
index 4ca6656..0485d2d 100644
--- a/doc/tmpl/output_scalar.sgml
+++ b/doc/tmpl/output_scalar.sgml
@@ -73,6 +73,7 @@ If neither max nor min are specified the bounding values are calculated before e
</para>
@v:
+ at name:
@min:
@max:
@maxlevel:
diff --git a/doc/tmpl/poisson.sgml b/doc/tmpl/poisson.sgml
index d30bd03..b8ce50f 100644
--- a/doc/tmpl/poisson.sgml
+++ b/doc/tmpl/poisson.sgml
@@ -64,6 +64,7 @@ Poisson solver
@max_depth:
@u:
@rhs:
+ at dia:
<!-- # Unused Parameters # -->
@root:
@level:
@@ -80,6 +81,7 @@ Poisson solver
@max_depth:
@u:
@rhs:
+ at dia:
@res:
<!-- # Unused Parameters # -->
@root:
@@ -92,6 +94,7 @@ Poisson solver
</para>
@domain:
+ at dia:
@c:
@rho:
@@ -108,6 +111,8 @@ Poisson solver
@nrelax:
@u:
@rhs:
+ at dia:
+ at res:
<!-- ##### FUNCTION gfs_correct_normal_velocities ##### -->
@@ -118,6 +123,7 @@ Poisson solver
@domain:
@dimension:
@p:
+ at g:
@dt:
<!-- # Unused Parameters # -->
@face:
@@ -132,6 +138,8 @@ Poisson solver
@domain:
@par:
@apar:
+ at p:
+ at g:
<!-- ##### FUNCTION gfs_approximate_projection ##### -->
@@ -142,6 +150,8 @@ Poisson solver
@domain:
@par:
@apar:
+ at p:
+ at res:
<!-- ##### FUNCTION gfs_domain_norm_residual ##### -->
@@ -153,6 +163,7 @@ Poisson solver
@flags:
@max_depth:
@dt:
+ at res:
@Returns:
diff --git a/doc/tmpl/refine_distance.sgml b/doc/tmpl/refine_distance.sgml
index bdd7eca..1e6d33a 100644
--- a/doc/tmpl/refine_distance.sgml
+++ b/doc/tmpl/refine_distance.sgml
@@ -6,7 +6,7 @@ Refining cells as a function of the distance to a surface
<!-- ##### SECTION Long_Description ##### -->
<para>
-For each candidate cell, GfsRefineDistance computes the distance from the cell center to the given surface. It then passes this distance as t argument to the user-defined function in order to get the maximum level of refinement allowed.
+For each candidate cell, GfsRefineDistance computes the distance from the cell center to the given surface. It then passes this distance as Distance argument to the user-defined function in order to get the maximum level of refinement allowed.
</para>
<para>
The syntax in parameter files is as follows:
diff --git a/src/ftt.c b/src/ftt.c
index 52402a9..6a58a39 100644
--- a/src/ftt.c
+++ b/src/ftt.c
@@ -1696,7 +1696,7 @@ void ftt_cell_destroy (FttCell * cell,
* @root: the root cell of a cell tree.
* @children: a #FttCellChildren.
* @cleanup: a #FttCellCleanupFunc to call before destroying a cell.
- # @data: user data to pass to @cleanup.
+ * @data: user data to pass to @cleanup.
*
* Destroys the root cell of a cell tree but not its children. Each
* child becomes the root cell of a new cell tree. The new (orphaned)
diff --git a/src/poisson.c b/src/poisson.c
index f607e58..5bfd458 100644
--- a/src/poisson.c
+++ b/src/poisson.c
@@ -807,6 +807,10 @@ static void diffusion_residual (FttCell * cell, RelaxParams * p)
/**
* gfs_diffusion_residual:
* @domain: a #GfsDomain.
+ * @u: the variable to use as left-hand side.
+ * @rhs: the right-hand side.
+ * @dia: the diagonal weight.
+ * @res: the residual.
*
* Sets the @res variable of each leaf cell of @domain to the residual
* of the diffusion equation for @v.
diff --git a/src/timestep.h b/src/timestep.h
index ad36e78..06f1177 100644
--- a/src/timestep.h
+++ b/src/timestep.h
@@ -77,7 +77,7 @@ void gfs_diffusion (GfsDomain * domain,
GfsVariable * dia);
void gfs_centered_velocity_advection_diffusion (GfsDomain * domain,
guint dimension,
- GfsAdvectionParams * par,
+ GfsAdvectionParams * apar,
GfsMultilevelParams * dpar,
GfsVariable ** g);
void gfs_tracer_advection_diffusion (GfsDomain * domain,
--
Gerris Flow Solver
More information about the debian-science-commits
mailing list