From 89ac6fa7e2811a18c949a5420f0de9afe584ae0a Mon Sep 17 00:00:00 2001 From: jthorn Date: Thu, 22 Jun 2006 15:35:12 +0000 Subject: += INOUT intent for aliaed-function arguments, as per http://www.cactuscode.org/old/pipermail/developers/2006-June/002882.html and following discussion git-svn-id: http://svn.cactuscode.org/flesh/trunk@4323 17b73243-c579-4c4c-a9d2-2d5706c11dac --- doc/UsersGuide/Appendices.tex | 8 ++++---- doc/UsersGuide/ThornWriters.tex | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) (limited to 'doc') diff --git a/doc/UsersGuide/Appendices.tex b/doc/UsersGuide/Appendices.tex index 3ef375ac..6f5f9e92 100644 --- a/doc/UsersGuide/Appendices.tex +++ b/doc/UsersGuide/Appendices.tex @@ -466,10 +466,10 @@ 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, -\texttt{<\var{intent*}>} must be either \verb|IN| or \verb|OUT|. An argument -should only be modified if it is declared to have intent -\verb|OUT|. If the argument is an array then the prefix \verb|ARRAY| -should also be given. +\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 +then the prefix \verb|ARRAY| should also be given. If the argument \texttt{<\var{arg*}>} is a function pointer then the argument itself (which will preceded by the return type) should be diff --git a/doc/UsersGuide/ThornWriters.tex b/doc/UsersGuide/ThornWriters.tex index ca912af9..b75efb78 100644 --- a/doc/UsersGuide/ThornWriters.tex +++ b/doc/UsersGuide/ThornWriters.tex @@ -4190,12 +4190,12 @@ includes the \texttt{cctk.h} header file. In a Fortran file, the declaration of the function will be included in the \texttt{DECLARE\_CCTK\_FUNCTIONS} macro, which is available after the statement \texttt{\#include "cctk\_Functions.h"}. -The keywords \texttt{IN} and \texttt{OUT} +The keywords \texttt{IN}, \texttt{OUT}, and \texttt{INOUT} work in the same fashion as \texttt{INTENT} statements in Fortran 90. That is, the C prototype will expect an argument with intent \texttt{IN} -to be a value and one with intent \texttt{OUT} to be a pointer. There -also exists the \texttt{ARRAY} keyword for passing arrays of any -dimension. +to be a value and one with intent \texttt{OUT} or \texttt{INOUT} to be a +pointer. There also exists the \texttt{ARRAY} keyword for passing arrays +of any dimension. Functions which are required by some thorn (which doesn't provide it itself) are checked at startup to be provided by some other thorn. -- cgit v1.2.3