aboutsummaryrefslogtreecommitdiff
path: root/doc/documention.tex
blob: 68f584bdb3262dfc30f578f54171b8373fdbcf1c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
\documentclass{article}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% MANPAGE like description setting for options, use as 
% \begin{Lentry} \item[text] text  \end{Lentry}

\usepackage{ifthen,calc}

\newcommand{\entrylabel}[1]{\mbox{\textsf{#1}}\hfil}
\newenvironment{entry}
  {\begin{list}{}
    {\renewcommand{\makelabel}{\entrylabel}
      \setlength{\labelwidth}{90pt}
      \setlength{\leftmargin}{\labelwidth+\labelsep}
    }
  }
  {\end{list}}

\newlength{\Mylen}
\newcommand{\Lentrylabel}[1]{%
  \settowidth{\Mylen}{\textsf{#1}}%
  \ifthenelse{\lengthtest{\Mylen > \labelwidth}}%
    {\parbox[b]{\labelwidth} %  term > labelwidth
      {\makebox[0pt][l]{\textsf{#1}}\\}} %
    {\textsf{#1}} %

  \hfil\relax}
\newenvironment{Lentry}
  {\renewcommand{\entrylabel}{\Lentrylabel}
   \begin{entry}}
  {\end{entry}}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%



\begin{document}

\title{PUGHReduce}
\author{Gabrielle Allen, Thomas Radke}
\date{2000}
\maketitle

\abstract{Reductions operations which are performed using the PUGH driver}

\section{Purpose}

This thorn registers a number of reduction operators with the flesh. The 
reductions are performed using internals of the PUGH driver, so that this
thorn can only be used when {\tt CactusPUGH/PUGH} is active.

The reduction operations this thorn registers are

\begin{Lentry}
\item[maximum]
	Calculates the maximum of a grid variable
\item[minimum]
	Calculates the minimum of a grid variable
\item[sum]
	Calculates the sum of the elements of a grid variable
\item[norm1]
	Calculates the norm of a grid variable
	$$
	\left(\Sigma | GV | \right)/n
	$$
	where $n$ is the number of elements
	
\item[norm2]
	Calculates the norm of a grid variable
	$$
	\sqrt{\Sigma GV^2}/n
	$$
	where $n$ is the number of elements
	
\end{Lentry}

\section{Examples}

\begin{itemize}

\item{} Maximum Value of a Grid Function

{\tt
\begin{verbatim}
    int ierr;
    int handle;         /* handle for reduction operator */
    int index; 	        /* grid variable index */
    CCTK_REAL *value;   /* value returned from reduction */
    const char *reduction_name = "maximum";
                        /* reduction operation to use */

    handle = CCTK_ReductionHandle (reduction_name);
    if (handle >= 0) 
    {
      if ( CCTK_Reduce (cctkGH, 0, handle, 
                        1, CCTK_VARIABLE_REAL,
                        &value, 1, index) == 0 
           && CCTK_MyProc(cctkGH) == 0)
      {
        printf("Reduction (%s) value is %f\n",reduction_name,value);
      }
    }
    else
    {
      CCTK_WARN(1,"Invalid reduction operator"); 
    }
\end{verbatim}
}

\end{itemize}


% Automatically created from the ccl files by using gmake thorndoc
\include{interface}
\include{param}
\include{schedule}

\end{document}