describe this directory and what files are in it

git-svn-id: http://svn.cactuscode.org/arrangements/CactusBase/LocalInterp/trunk@84 df1f8a13-aa1d-4dd4-9681-27ded5b42416

1 files changed, 55 insertions, 0 deletions

diff --git a/src/GeneralizedPolynomial-Uniform/Lagrange/README b/src/GeneralizedPolynomial-Uniform/Lagrange/README
new file mode 100644
index 0000000..ec861ac
--- /dev/null
+++ b/src/GeneralizedPolynomial-Uniform/Lagrange/README
@@ -0,0 +1,55 @@
+$Header$
+
+This directory contains code for Lagrange polynomial interpolation.
+
+makefile
+	This has targets to create the subdirectories for the
+	Maple-generated coefficient files, and to run Maple to
+	generated those files.
+
+make.code.defn
+	This tells the Cactus build system which files to compile.
+
+[123]d.maple
+	These files contain the Maple code to generate the interpolation
+	coefficients.
+
+fns.maple
+	These files define the interpolation functions, coefficients, etc,
+	for the Maple code in [123]d.maple
+
+[123]d.cube.order?.smooth0.c
+	These files are the individual cases for the interpolation.
+	Each file defines a separate function.  Each file just #defines
+	a bunch of macros, then #includes "../template.c" to get the
+	actual interpolation code.  The functions are named
+	   LocalInterp_ULagrange_1dcube_10
+	   LocalInterp_ULagrange_1dcube_20
+	   LocalInterp_ULagrange_1dcube_30
+	   LocalInterp_ULagrange_1dcube_40
+	   LocalInterp_ULagrange_1dcube_50
+	   LocalInterp_ULagrange_1dcube_60
+	   LocalInterp_ULagrange_2dcube_10
+	   LocalInterp_ULagrange_2dcube_20
+	   LocalInterp_ULagrange_2dcube_30
+	   LocalInterp_ULagrange_2dcube_40
+	   LocalInterp_ULagrange_3dcube_10
+	   LocalInterp_ULagrange_3dcube_20
+	   LocalInterp_ULagrange_3dcube_30
+	   LocalInterp_ULagrange_3dcube_40
+	The naming convention is as follows (eg for the last function)
+	   LocalInterp		name of this thorn
+	   U			these functions are all for the
+				CCTK_InterpLocalUniform() API
+	   Lagrange		these functions are all for the
+				"Lagrange polynomial interpolation"
+				interpolation operator
+	   3d			this function does 3-d interpolation
+	   cube			this function uses a cube-shaped
+				interpolation molecule
+	   4			this function does 4th order interpolation
+	   0			this function does smoothing=0 interpolation
+
+all_prototypes.h
+	This file contains C prototypes for each of the functions
+	in [123]d.cube.order?.smooth0.c.