[cig-commits] [commit] master: update inclusion benchmark in manual (7107331)

[cig_noreply at geodynamics.org]

Repository : https://github.com/geodynamics/aspect

On branch  : master
Link       : https://github.com/geodynamics/aspect/compare/c883fc069e0dcc93cce45e1d52c84c05c9c4385b...1f4ab820b0191d9a4058b78c91b629bc94c437ec

>---------------------------------------------------------------

commit 71073317f1f73be33c820121e2771be1c786e3ee
Author: Timo Heister <timo.heister at gmail.com>
Date:   Tue May 20 16:37:40 2014 -0400

    update inclusion benchmark in manual


>---------------------------------------------------------------

71073317f1f73be33c820121e2771be1c786e3ee
 .../manual/cookbooks/benchmarks}/inclusion.prm     |  9 ++-
 doc/manual/manual.tex                              | 86 ++--------------------
 2 files changed, 11 insertions(+), 84 deletions(-)

diff --git a/cookbooks/future/inclusion.prm b/doc/manual/cookbooks/benchmarks/inclusion.prm
similarity index 81%
rename from cookbooks/future/inclusion.prm
rename to doc/manual/cookbooks/benchmarks/inclusion.prm
index 81ededc..9bb26a1 100644
--- a/cookbooks/future/inclusion.prm
+++ b/doc/manual/cookbooks/benchmarks/inclusion.prm
@@ -1,5 +1,8 @@
 ############### Global parameters
 
+set Additional shared libraries            = ./libplugin.so
+
+
 set Dimension                              = 2
 
 set Start time                             = 0
@@ -23,14 +26,14 @@ end
 
 
 subsection Model settings
-  set Prescribed velocity boundary indicators = 0:inclusion, 1:inclusion, 2:inclusion, 3:inclusion
+  set Prescribed velocity boundary indicators = 0:InclusionBoundary, 1:InclusionBoundary, 2:InclusionBoundary, 3:InclusionBoundary
   set Tangential velocity boundary indicators =
   set Zero velocity boundary indicators       =
 end
 
 
 subsection Material model
-  set Model name = Inclusion
+  set Model name = InclusionMaterial
 
   subsection Inclusion
     set Viscosity jump = 1e3
@@ -73,5 +76,5 @@ end
 ############### Parameters describing the what to do with the solution
 
 subsection Postprocess
-  set List of postprocessors = DuretzEtAl error, visualization
+  set List of postprocessors = InclusionPostprocessor, visualization
 end
diff --git a/doc/manual/manual.tex b/doc/manual/manual.tex
index 96c23c2..efb3d5b 100644
--- a/doc/manual/manual.tex
+++ b/doc/manual/manual.tex
@@ -5902,90 +5902,14 @@ Fig.~\ref{fig:inclusion}. As before, for details we refer to
   \end{center}
 \end{figure}
 
-As before, the benchmark can be run with a small variation of the input files
-already discussed above:
-\marginpar{Revisit this once we have the machinery in place to choose nonzero
-  boundary conditions in a more elegant way.}
-
-\begin{lstlisting}[frame=single,language=prmfile]
-############### Global parameters
-
-set Dimension                              = 2
-
-set Start time                             = 0
-set End time                               = 0
+The benchmark can be run using the parameter files in \url{benchmark/inclusion/}. The material model, boundary condition, and postprocessor are defined in \url{benchmark/inclusion/inclusion.cc}. Consequently, this code needs to be compiled into a shared lib before you can run the tests.
 
-set Output directory                       = output
-
-set Pressure normalization                 = volume
-
-
-############### Parameters describing the model
-
-subsection Geometry model
-  set Model name = box
+\marginpar{Link to a general section on how you can compile libs for the benchmarks.}
 
-  subsection Box
-    set X extent = 2
-    set Y extent = 2
-  end
-end
-
-
-subsection Model settings
-  set Prescribed velocity boundary indicators = 0,1,2,3
-  set Tangential velocity boundary indicators =
-  set Zero velocity boundary indicators       =
-end
-
-
-subsection Material model
-  set Model name = Inclusion
-
-  subsection Inclusion
-    set Viscosity jump = 1e3
-  end
-end
-
-
-subsection Gravity model
-  set Model name = vertical
-end
-
-
-############### Parameters describing the temperature field
-
-subsection Boundary temperature model
-  set Model name = box
-end
-
-
-subsection Initial conditions
-  set Model name = perturbed box
-end
-
-
-
-############### Parameters describing the discretization
-
-subsection Discretization
-  set Stokes velocity polynomial degree       = 2
-  set Use locally conservative discretization = false
-end
-
-
-subsection Mesh refinement
-  set Initial adaptive refinement              = 0
-  set Initial global refinement                = 6
-end
-
-
-############### Parameters describing the what to do with the solution
+\marginpar{Revisit this once we have the machinery in place to choose nonzero
+  boundary conditions in a more elegant way.}
 
-subsection Postprocess
-  set List of postprocessors = DuretzEtAl error, visualization
-end
-\end{lstlisting}
+\lstinputlisting[frame=single,language=prmfile]{cookbooks/benchmarks/inclusion.prm}
 
 \subsubsection{The ``Stokes' law'' benchmark}
 \label{sec:benchmark-stokes_law}