[cig-commits] r6376 - in mc/3D/CitcomS/trunk: doc/manual examples/Full examples/Regional

[tan2 at geodynamics.org]

Author: tan2
Date: 2007-03-23 13:40:27 -0700 (Fri, 23 Mar 2007)
New Revision: 6376

Modified:
   mc/3D/CitcomS/trunk/doc/manual/citcoms.lyx
   mc/3D/CitcomS/trunk/examples/Full/input.sample
   mc/3D/CitcomS/trunk/examples/Regional/input.sample
Log:
Added the tracer parameters to the manual and sample input files

Modified: mc/3D/CitcomS/trunk/doc/manual/citcoms.lyx
===================================================================
--- mc/3D/CitcomS/trunk/doc/manual/citcoms.lyx	2007-03-23 20:40:24 UTC (rev 6375)
+++ mc/3D/CitcomS/trunk/doc/manual/citcoms.lyx	2007-03-23 20:40:27 UTC (rev 6376)
@@ -11734,6 +11734,318 @@
 \end_layout
 
 \begin_layout Subsection
+Tracer Parameters
+\end_layout
+
+\begin_layout Standard
+\begin_inset Tabular
+<lyxtabular version="3" rows="9" columns="2">
+<features>
+<column alignment="left" valignment="top" leftline="true" width="1.85in">
+<column alignment="left" valignment="top" leftline="true" rightline="true" width="3.5in">
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+
+\family typewriter
+\size small
+tracer=off
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+If on, enable the tracers.
+ 
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+
+\family typewriter
+\size small
+tracer_ic_method=0
+\newline
+tracers_per_element=10
+\newline
+tracer_file="tracer.dat"
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+Specify the initial location of the tracers.
+ If 
+\family typewriter
+\size small
+tracer_ic_method=0
+\family default
+\size default
+, the tracers are generated randomly, with the number of tracers per element
+ speicified by 
+\family typewriter
+\size small
+tracers_per_element
+\family default
+\size default
+.
+ If 
+\family typewriter
+\size small
+tracer_ic_method=1
+\family default
+\size default
+, the location of the tracers are read from a file specified in 
+\family typewriter
+\size small
+tracer_file
+\family default
+\size default
+.
+ If 
+\family typewriter
+\size small
+tracer_ic_method=
+\family default
+\size default
+2, the location of the tracers are read from the old tracer output, similar
+ to 
+\family typewriter
+\size small
+restart=on
+\family default
+\size default
+.
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+
+\family typewriter
+\size small
+tracer_flavors=0
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+The number of flavors among the tracers.
+ If it is 0, flavor counting is turned off.
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+
+\family typewriter
+\size small
+ic_method_for_flavors=0
+\newline
+z_interface=0.7
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+Specify the initial flavors of the tracers.
+ Used only when 
+\family typewriter
+\size small
+tracer_ic_method=0
+\family default
+\size default
+.
+ Currently, only 
+\family typewriter
+\size small
+ic_method_for_flavors=0
+\family default
+\size default
+ is supported.
+ A layered structure is generated.
+ Tracers above 
+\family typewriter
+\size small
+z_interface
+\family default
+\size default
+ is of flavor 0, otherwise, of flavor 1.
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+
+\family typewriter
+\size small
+regular_grid_deltheta=1.0
+\newline
+regular_grid_delphi=1.0
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+The grid space of the regular grid.
+ The regular grid is an auxillary grid to help locating the tracers.
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+
+\family typewriter
+\size small
+chemical_buoyancy=on
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+If on, enable thermo-chemical convection.
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+
+\family typewriter
+\size small
+buoy_type=1
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+If 
+\family typewriter
+\size small
+buoy_type=1
+\family default
+\size default
+, the composition field is determined by the ratio method.
+ (Other method is not implemented yet.) 
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+
+\family typewriter
+\size small
+buoyancy_ratio=1.0
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+The ratio of chemical density anomaly to the reference density
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row topline="true" bottomline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+
+\family typewriter
+\size small
+reset_initial_composition=off
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+Whether to reset the initial bulk composition or use the restarted value.
+ Used when 
+\family typewriter
+\size small
+tracer_ic_method=
+\family default
+\size default
+2.
+\end_layout
+
+\end_inset
+</cell>
+</row>
+</lyxtabular>
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Subsection
 Dimensional Information
 \end_layout
 
@@ -15601,7 +15913,7 @@
 \begin_layout Standard
 \noindent
 \begin_inset Tabular
-<lyxtabular version="3" rows="2" columns="2">
+<lyxtabular version="3" rows="13" columns="2">
 <features>
 <column alignment="left" valignment="top" leftline="true" rightline="true" width="1.85in">
 <column alignment="left" valignment="top" rightline="true" width="3.5in">
@@ -15628,7 +15940,7 @@
 \end_inset
 </cell>
 </row>
-<row topline="true" bottomline="true">
+<row topline="true">
 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
 \begin_inset Text
 
@@ -15636,11 +15948,264 @@
 
 \family typewriter
 \size small
+tracer_ic_method=0
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+
+\family typewriter
+\size small
+tracers_per_element=10
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+
+\family typewriter
+\size small
 tracer_file="tracer.dat"
 \end_layout
 
 \end_inset
 </cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+
+\family typewriter
+\size small
+tracer_flavors=0
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+
+\family typewriter
+\size small
+ic_method_for_flavors=0
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+
+\family typewriter
+\size small
+z_interface=0.7
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+
+\family typewriter
+\size small
+regular_grid_deltheta=1.0
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+
+\family typewriter
+\size small
+regular_grid_delphi=1.0
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+
+\family typewriter
+\size small
+chemical_buoyancy=on
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+
+\family typewriter
+\size small
+buoy_type=1
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row topline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+
+\family typewriter
+\size small
+buoyancy_ratio=1.0
+\end_layout
+
+\end_inset
+</cell>
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+
+\end_layout
+
+\end_inset
+</cell>
+</row>
+<row topline="true" bottomline="true">
+<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
+\begin_inset Text
+
+\begin_layout Standard
+
+\family typewriter
+\size small
+reset_initial_composition=off
+\end_layout
+
+\end_inset
+</cell>
 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
 \begin_inset Text
 

Modified: mc/3D/CitcomS/trunk/examples/Full/input.sample
===================================================================
--- mc/3D/CitcomS/trunk/examples/Full/input.sample	2007-03-23 20:40:24 UTC (rev 6375)
+++ mc/3D/CitcomS/trunk/examples/Full/input.sample	2007-03-23 20:40:27 UTC (rev 6376)
@@ -144,6 +144,26 @@
 visc_max=1.0e1
 
 
+# Tracer information
+tracer=off
+
+tracer_ic_method=0
+tracers_per_element=10
+tracer_file="tracer.dat"
+
+tracer_flavors=0
+ic_method_for_flavors=0
+z_interface=0.700000
+
+regular_grid_deltheta=1.0
+regular_grid_delphi=1.0
+
+chemical_buoyancy=on
+buoy_type=1
+buoyancy_ratio=1.0
+reset_initial_composition=off
+
+
 # Phase Change Information
 Ra_410=0.0
 clapeyron410=0.0235

Modified: mc/3D/CitcomS/trunk/examples/Regional/input.sample
===================================================================
--- mc/3D/CitcomS/trunk/examples/Regional/input.sample	2007-03-23 20:40:24 UTC (rev 6375)
+++ mc/3D/CitcomS/trunk/examples/Regional/input.sample	2007-03-23 20:40:27 UTC (rev 6376)
@@ -151,6 +151,23 @@
 visc_max=1.0e1
 
 
+# Tracer information
+tracer=off
+
+tracer_ic_method=0
+tracers_per_element=10
+tracer_file="tracer.dat"
+
+tracer_flavors=0
+ic_method_for_flavors=0
+z_interface=0.700000
+
+chemical_buoyancy=on
+buoy_type=1
+buoyancy_ratio=1.0
+reset_initial_composition=off
+
+
 # Phase Change Information
 Ra_410=0.0
 clapeyron410=0.0235