diff options
| author | schnetter <schnetter@17b73243-c579-4c4c-a9d2-2d5706c11dac> | 2006-11-14 20:46:33 +0000 |
|---|---|---|
| committer | schnetter <schnetter@17b73243-c579-4c4c-a9d2-2d5706c11dac> | 2006-11-14 20:46:33 +0000 |
| commit | 8caf4638af85ba77f00941b0be6b1085967da12d (patch) | |
| tree | 475f383d6efe91c12628ddbcab6c722c22848972 /doc | |
| parent | bfb8283626b0296b4d169fc8532bbf50bd62c095 (diff) | |
Document that CCTK_COMPLEX is now allowed in aliased functions.
git-svn-id: http://svn.cactuscode.org/flesh/trunk@4388 17b73243-c579-4c4c-a9d2-2d5706c11dac
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/UsersGuide/Appendices.tex | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/doc/UsersGuide/Appendices.tex b/doc/UsersGuide/Appendices.tex index 3265c6bd..82a8b86b 100644 --- a/doc/UsersGuide/Appendices.tex +++ b/doc/UsersGuide/Appendices.tex @@ -459,13 +459,14 @@ the prototype must be declared with the form: \begin{alltt} <\var{return_type}> FUNCTION <\var{alias}>(<\var{arg1_type}> <\var{intent1}> [ARRAY] <\var{arg1}>, ...) \end{alltt} -The \texttt{<\var{return\_type}>} must be either \verb|void|, \verb|CCTK_INT| -or \verb|CCTK_REAL|. The keyword \verb|SUBROUTINE| is equivalent to +The \texttt{<\var{return\_type}>} must be either \verb|void|, \verb|CCTK_INT|, +\verb|CCTK_REAL|, or \verb|CCTK_COMPLEX|. +The keyword \verb|SUBROUTINE| is equivalent to \verb|void FUNCTION|. The name of the aliased function \texttt{<\var{alias}>} must contain at least one uppercase and one lowercase letter and follow the C standard for function names. The type of each argument, \texttt{<\var{arg*\_type}>} must be a \verb|CCTK| type in -\verb|INT,REAL,STRING,POINTER|. The intent of each argument, +\verb|INT,REAL,COMPLEX,STRING,POINTER|. The intent of each argument, \texttt{<\var{intent*}>} must be either \verb|IN|, \verb|OUT|, or \verb|INOUT|. An argument should only be modified if it is declared to have intent \verb|OUT| or \verb|INOUT|. If the argument is an array @@ -533,7 +534,7 @@ carriage return. groups of variables. {\t \var{access}} can be either {\t public}, {\t protected} or {\t private}. \item{} {\t \var{data\_type}} defines the data type of the variables in the -group. Supported data types are {\t CHAR}, {\t BYTE}, {\t INT}, {\t REAL} and +group. Supported data types are {\t CHAR}, {\t BYTE}, {\t INT}, {\t REAL}, and {\t COMPLEX}. \item{} {\t \var{group\_name}} must be an alphanumeric name (which may also contain underscores) which is unique across group and variable names |