diff options
author | hawke <hawke@578cdeb0-5ea1-4b81-8215-5a3b8777ee0b> | 2003-05-24 14:38:34 +0000 |
---|---|---|
committer | hawke <hawke@578cdeb0-5ea1-4b81-8215-5a3b8777ee0b> | 2003-05-24 14:38:34 +0000 |
commit | 24e2bf00aac01104dd269c9279920e1a516ca20d (patch) | |
tree | dc955b6939bbb56a6dab63ecd516bbe0d5a5e9e1 /doc | |
parent | 627caa6bdf1e4b6db96a799454303d8b2e7935fe (diff) |
Update the documentation.
git-svn-id: http://svn.cactuscode.org/arrangements/CactusNumerical/MoL/trunk@14 578cdeb0-5ea1-4b81-8215-5a3b8777ee0b
Diffstat (limited to 'doc')
-rw-r--r-- | doc/documentation.tex | 1327 |
1 files changed, 6 insertions, 1321 deletions
diff --git a/doc/documentation.tex b/doc/documentation.tex index 1b86f4b..4934e84 100644 --- a/doc/documentation.tex +++ b/doc/documentation.tex @@ -364,12 +364,12 @@ USES FUNCTION MoLChangeToSaveAndRestore USES FUNCTION MoLChangeToNone \end{verbatim} -Note that the list of paramters and functions is not complete; only -the case of real GFs is covered. MoL will evolve complex GFs and real -and complex grid arrays. For these cases the functions and parameters -have different names but the use and interfaces are identical. See the -section on parameters and the section on functions (\ref{sec:molfns}) -for the precise names. +Note that the list of paramters not complete; see the section on +parameters for the use of arrays or complex variables. However, the +list of functions is, and is expanded on in section~\ref{sec:molfns}. +MoL will check whether a group or variable is a GF or an array and +whether it is real or complex. Note that currently complex variable +support is disabled. Having done that, one routine (or group of routines) which we'll here call {\tt Thorn\_CalcRHS} must be defined. This does all the finite @@ -1275,1321 +1275,6 @@ ierr = MoLChangeToNone(RemoveIndex) -\begin{FunctionDescription}{MoLRegisterEvolvedComplex} - \label{MoLRegisterEvolvedComplex} - - Tells MoL that the given \textbf{complex} GF is in the evolved - category with the associated update \textbf{complex} GF. - - \begin{SynopsisSection} - \begin{Synopsis}{C} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterEvolvedComplex(CCTK_INT EvolvedIndex, - CCTK_INT RHSIndex) -\end{verbatim} - \end{Synopsis} - \begin{Synopsis}{Fortran} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterEvolvedComplex(CCTK_INT EvolvedIndex, - CCTK_INT RHSIndex) -\end{verbatim} - \end{Synopsis} - \end{SynopsisSection} - - \begin{ResultSection} - \begin{ResultNote} - Currently if there is an error, MoL will issue a level 0 - warning. No sensible return codes exist. - \end{ResultNote} - \begin{Result}{\rm 0} - success - \end{Result} - \end{ResultSection} - - \begin{ParameterSection} - \begin{Parameter}{EvolvedIndex} - Index of the GF to be evolved. - \end{Parameter} - \begin{Parameter}{RHSIndex} - Index of the associated update GF. - \end{Parameter} - \end{ParameterSection} - - \begin{Discussion} - Should be called in a function scheduled in {\tt MoL\_Register}. - \end{Discussion} - - \begin{SeeAlsoSection} - \begin{SeeAlso}{CCTK\_VarIndex()} - Get the variable index. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterSaveAndRestoreComplex()} - Register Save and Restore variables. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterConstrainedComplex()} - Register constrained variables. - \end{SeeAlso} - \begin{SeeAlso}{MoLChangeToEvolvedComplex()} - Change a variable at runtime to be evolved. - \end{SeeAlso} - \end{SeeAlsoSection} - - \begin{ExampleSection} - \begin{Example}{C} -\begin{verbatim} -ierr = MoLRegisterEvolvedComplex(CCTK_VarIndex("MyThorn::ComplexVar"), - CCTK_VarIndex("MyThorn::ComplexRHS")); -\end{verbatim} - \end{Example} - \begin{Example}{Fortran} -\begin{verbatim} -call CCTK_VarIndex(EvolvedIndex, "MyThorn::ComplexVar") -call CCTK_VarIndex(RHSIndex, "MyThorn::ComplexRHS") -ierr = MoLRegisterEvolvedComplex(EvolvedIndex, RHSIndex) -\end{verbatim} - \end{Example} - \end{ExampleSection} - -\end{FunctionDescription} - - - -\begin{FunctionDescription}{MoLRegisterConstrainedComplex} - \label{MoLRegisterConstrainedComplex} - - Tells MoL that the given \textbf{complex} GF is in the constrained - category. - - \begin{SynopsisSection} - \begin{Synopsis}{C} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterConstrainedComplex(CCTK_INT ConstrainedIndex) -\end{verbatim} - \end{Synopsis} - \begin{Synopsis}{Fortran} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterConstrainedComplex(CCTK_INT ConstrainedIndex) -\end{verbatim} - \end{Synopsis} - \end{SynopsisSection} - - \begin{ResultSection} - \begin{ResultNote} - Currently if there is an error, MoL will issue a level 0 - warning. No sensible return codes exist. - \end{ResultNote} - \begin{Result}{\rm 0} - success - \end{Result} - \end{ResultSection} - - \begin{ParameterSection} - \begin{Parameter}{ConstrainedIndex} - Index of the constrained \textbf{complex} GF. - \end{Parameter} - \end{ParameterSection} - - \begin{Discussion} - Should be called in a function scheduled in {\tt MoL\_Register}. - \end{Discussion} - - \begin{SeeAlsoSection} - \begin{SeeAlso}{CCTK\_VarIndex()} - Get the variable index. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterEvolvedComplex()} - Register evolved variables. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterSaveAndRestoreComplex()} - Register Save and Restore variables. - \end{SeeAlso} - \begin{SeeAlso}{MoLChangeToConstrainedComplex()} - Change a variable at runtime to be constrained. - \end{SeeAlso} - \end{SeeAlsoSection} - - \begin{ExampleSection} - \begin{Example}{C} -\begin{verbatim} -ierr = MoLRegisterConstrainedComplex(CCTK_VarIndex("MyThorn::ComplexVar")); -\end{verbatim} - \end{Example} - \begin{Example}{Fortran} -\begin{verbatim} -call CCTK_VarIndex(ConstrainedIndex, "MyThorn::ComplexVar") -ierr = MoLRegisterConstrainedComplex(ConstrainedIndex) -\end{verbatim} - \end{Example} - \end{ExampleSection} - -\end{FunctionDescription} - - - -\begin{FunctionDescription}{MoLRegisterSaveAndRestoreComplex} - \label{MoLRegisterSaveAndRestoreComplex} - - Tells MoL that the given \textbf{complex} GF is in the Save and - Restore category. - - \begin{SynopsisSection} - \begin{Synopsis}{C} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterSaveAndRestoreComplex(CCTK_INT SandRIndex) -\end{verbatim} - \end{Synopsis} - \begin{Synopsis}{Fortran} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterSaveAndRestoreComplex(CCTK_INT SandRIndex) -\end{verbatim} - \end{Synopsis} - \end{SynopsisSection} - - \begin{ResultSection} - \begin{ResultNote} - Currently if there is an error, MoL will issue a level 0 - warning. No sensible return codes exist. - \end{ResultNote} - \begin{Result}{\rm 0} - success - \end{Result} - \end{ResultSection} - - \begin{ParameterSection} - \begin{Parameter}{SandRIndex} - Index of the Save and Restore \textbf{complex} GF. - \end{Parameter} - \end{ParameterSection} - - \begin{Discussion} - Should be called in a function scheduled in {\tt MoL\_Register}. - \end{Discussion} - - \begin{SeeAlsoSection} - \begin{SeeAlso}{CCTK\_VarIndex()} - Get the variable index. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterEvolvedComplex()} - Register evolved variables. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterConstrainedComplex()} - Register constrained variables. - \end{SeeAlso} - \begin{SeeAlso}{MoLChangeToSaveAndRestoreComplex()} - Change a variable at runtime to be Save and Restore. - \end{SeeAlso} - \end{SeeAlsoSection} - - \begin{ExampleSection} - \begin{Example}{C} -\begin{verbatim} -ierr = MoLRegisterSaveAndRestoreComplex(CCTK_VarIndex("MyThorn::ComplexVar")); -\end{verbatim} - \end{Example} - \begin{Example}{Fortran} -\begin{verbatim} -call CCTK_VarIndex(SandRIndex, "MyThorn::ComplexVar") -ierr = MoLRegisterSaveAndRestoreComplex(SandRIndex) -\end{verbatim} - \end{Example} - \end{ExampleSection} - -\end{FunctionDescription} - - - -\begin{FunctionDescription}{MoLRegisterEvolvedComplexGroup} - \label{MoLRegisterEvolvedComplexGroup} - - Tells MoL that the given \textbf{complex} group is in the evolved - category with the associated update group. - - \begin{SynopsisSection} - \begin{Synopsis}{C} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterEvolvedComplexGroup(CCTK_INT EvolvedIndex, - CCTK_INT RHSIndex) -\end{verbatim} - \end{Synopsis} - \begin{Synopsis}{Fortran} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterEvolvedComplexGroup(CCTK_INT EvolvedIndex, - CCTK_INT RHSIndex) -\end{verbatim} - \end{Synopsis} - \end{SynopsisSection} - - \begin{ResultSection} - \begin{ResultNote} - Currently if there is an error, MoL will issue a level 0 - warning. No sensible return codes exist. - \end{ResultNote} - \begin{Result}{\rm 0} - success - \end{Result} - \end{ResultSection} - - \begin{ParameterSection} - \begin{Parameter}{EvolvedIndex} - Index of the \textbf{complex} group to be evolved. - \end{Parameter} - \begin{Parameter}{RHSIndex} - Index of the associated update \textbf{complex} group. - \end{Parameter} - \end{ParameterSection} - - \begin{Discussion} - Should be called in a function scheduled in {\tt MoL\_Register}. - \end{Discussion} - - \begin{SeeAlsoSection} - \begin{SeeAlso}{CCTK\_GroupIndex()} - Get the group index. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterSaveAndRestoreComplexGroup()} - Register Save and Restore variables. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterConstrainedComplexGroup()} - Register constrained variables. - \end{SeeAlso} - \end{SeeAlsoSection} - - \begin{ExampleSection} - \begin{Example}{C} -\begin{verbatim} -ierr = MoLRegisterEvolvedComplexGroup(CCTK_GroupIndex("MyThorn::ComplexVar"), - CCTK_GroupIndex("MyThorn::ComplexRHS")); -\end{verbatim} - \end{Example} - \begin{Example}{Fortran} -\begin{verbatim} -call CCTK_GroupIndex(EvolvedIndex, "MyThorn::ComplexVar") -call CCTK_GroupIndex(RHSIndex, "MyThorn::ComplexRHS") -ierr = MoLRegisterEvolvedComplexGroup(EvolvedIndex, RHSIndex) -\end{verbatim} - \end{Example} - \end{ExampleSection} - -\end{FunctionDescription} - - - -\begin{FunctionDescription}{MoLRegisterConstrainedComplexGroup} - \label{MoLRegisterConstrainedComplexGroup} - - Tells MoL that the given \textbf{complex} group is in the - constrained category. - - \begin{SynopsisSection} - \begin{Synopsis}{C} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterConstrainedComplexGroup(CCTK_INT ConstrainedIndex) -\end{verbatim} - \end{Synopsis} - \begin{Synopsis}{Fortran} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterConstrainedComplexGroup(CCTK_INT ConstrainedIndex) -\end{verbatim} - \end{Synopsis} - \end{SynopsisSection} - - \begin{ResultSection} - \begin{ResultNote} - Currently if there is an error, MoL will issue a level 0 - warning. No sensible return codes exist. - \end{ResultNote} - \begin{Result}{\rm 0} - success - \end{Result} - \end{ResultSection} - - \begin{ParameterSection} - \begin{Parameter}{ConstrainedIndex} - Index of the constrained \textbf{complex} group. - \end{Parameter} - \end{ParameterSection} - - \begin{Discussion} - Should be called in a function scheduled in {\tt MoL\_Register}. - \end{Discussion} - - \begin{SeeAlsoSection} - \begin{SeeAlso}{CCTK\_GroupIndex()} - Get the group index. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterEvolvedComplexGroup()} - Register evolved variables. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterSaveAndRestoreComplexGroup()} - Register Save and Restore variables. - \end{SeeAlso} - \begin{SeeAlso}{MoLChangeToConstrainedComplex()} - Change a variable at runtime to be constrained. - \end{SeeAlso} - \end{SeeAlsoSection} - - \begin{ExampleSection} - \begin{Example}{C} -\begin{verbatim} -ierr = MoLRegisterConstrainedGroupComplex(CCTK_VarIndex("MyThorn::ComplexVar")); -\end{verbatim} - \end{Example} - \begin{Example}{Fortran} -\begin{verbatim} -call CCTK_GroupIndex(ConstrainedIndex, "MyThorn::ComplexVar") -ierr = MoLRegisterConstrainedComplexGroup(ConstrainedIndex) -\end{verbatim} - \end{Example} - \end{ExampleSection} - -\end{FunctionDescription} - - - -\begin{FunctionDescription}{MoLRegisterSaveAndRestoreComplexGroup} - \label{MoLRegisterSaveAndRestoreComplexGroup} - - Tells MoL that the given \textbf{complex} group is in the Save and - Restore category. - - \begin{SynopsisSection} - \begin{Synopsis}{C} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterSaveAndRestoreComplexGroup(CCTK_INT SandRIndex) -\end{verbatim} - \end{Synopsis} - \begin{Synopsis}{Fortran} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterSaveAndRestoreComplexGroup(CCTK_INT SandRIndex) -\end{verbatim} - \end{Synopsis} - \end{SynopsisSection} - - \begin{ResultSection} - \begin{ResultNote} - Currently if there is an error, MoL will issue a level 0 - warning. No sensible return codes exist. - \end{ResultNote} - \begin{Result}{\rm 0} - success - \end{Result} - \end{ResultSection} - - \begin{ParameterSection} - \begin{Parameter}{SandRIndex} - Index of the save and restore group. - \end{Parameter} - \end{ParameterSection} - - \begin{Discussion} - Should be called in a function scheduled in {\tt MoL\_Register}. - \end{Discussion} - - \begin{SeeAlsoSection} - \begin{SeeAlso}{CCTK\_GroupIndex()} - Get the group index. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterEvolvedComplexGroup()} - Register evolved variables. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterConstrainedComplexGroup()} - Register constrained variables. - \end{SeeAlso} - \end{SeeAlsoSection} - - \begin{ExampleSection} - \begin{Example}{C} -\begin{verbatim} -ierr = MoLRegisterSaveAndRestoreComplexGroup(CCTK_GroupIndex("MyThorn::ComplexVar")); -\end{verbatim} - \end{Example} - \begin{Example}{Fortran} -\begin{verbatim} -call CCTK_GroupIndex(SandRIndex, "MyThorn::ComplexVar") -ierr = MoLRegisterSaveAndRestoreComplexGroup(SandRIndex) -\end{verbatim} - \end{Example} - \end{ExampleSection} - -\end{FunctionDescription} - - -\begin{FunctionDescription}{MoLRegisterEvolvedArray} - \label{MoLRegisterEvolvedArray} - - Tells MoL that the given \textbf{array} GF is in the evolved - category with the associated update \textbf{array} GF. - - \begin{SynopsisSection} - \begin{Synopsis}{C} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterEvolvedArray(CCTK_INT EvolvedIndex, - CCTK_INT RHSIndex) -\end{verbatim} - \end{Synopsis} - \begin{Synopsis}{Fortran} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterEvolvedArray(CCTK_INT EvolvedIndex, - CCTK_INT RHSIndex) -\end{verbatim} - \end{Synopsis} - \end{SynopsisSection} - - \begin{ResultSection} - \begin{ResultNote} - Currently if there is an error, MoL will issue a level 0 - warning. No sensible return codes exist. - \end{ResultNote} - \begin{Result}{\rm 0} - success - \end{Result} - \end{ResultSection} - - \begin{ParameterSection} - \begin{Parameter}{EvolvedIndex} - Index of the \textbf{array} to be evolved. - \end{Parameter} - \begin{Parameter}{RHSIndex} - Index of the associated update \textbf{array}. - \end{Parameter} - \end{ParameterSection} - - \begin{Discussion} - Should be called in a function scheduled in {\tt MoL\_Register}. - \end{Discussion} - - \begin{SeeAlsoSection} - \begin{SeeAlso}{CCTK\_VarIndex()} - Get the variable index. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterSaveAndRestoreArray()} - Register Save and Restore variables. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterConstrainedArray()} - Register constrained variables. - \end{SeeAlso} - \begin{SeeAlso}{MoLChangeToEvolvedArray()} - Change a variable at runtime to be evolved. - \end{SeeAlso} - \end{SeeAlsoSection} - - \begin{ExampleSection} - \begin{Example}{C} -\begin{verbatim} -ierr = MoLRegisterEvolvedArray(CCTK_VarIndex("MyThorn::MyArray"), - CCTK_VarIndex("MyThorn::MyArray")); -\end{verbatim} - \end{Example} - \begin{Example}{Fortran} -\begin{verbatim} -call CCTK_VarIndex(EvolvedIndex, "MyThorn::MyArray") -call CCTK_VarIndex(RHSIndex, "MyThorn::MyArray") -ierr = MoLRegisterEvolvedArray(EvolvedIndex, RHSIndex) -\end{verbatim} - \end{Example} - \end{ExampleSection} - -\end{FunctionDescription} - - - -\begin{FunctionDescription}{MoLRegisterConstrainedArray} - \label{MoLRegisterConstrainedArray} - - Tells MoL that the given \textbf{array} GF is in the constrained - category. - - \begin{SynopsisSection} - \begin{Synopsis}{C} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterConstrainedArray(CCTK_INT ConstrainedIndex) -\end{verbatim} - \end{Synopsis} - \begin{Synopsis}{Fortran} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterConstrainedArray(CCTK_INT ConstrainedIndex) -\end{verbatim} - \end{Synopsis} - \end{SynopsisSection} - - \begin{ResultSection} - \begin{ResultNote} - Currently if there is an error, MoL will issue a level 0 - warning. No sensible return codes exist. - \end{ResultNote} - \begin{Result}{\rm 0} - success - \end{Result} - \end{ResultSection} - - \begin{ParameterSection} - \begin{Parameter}{ConstrainedIndex} - Index of the constrained \textbf{array}. - \end{Parameter} - \end{ParameterSection} - - \begin{Discussion} - Should be called in a function scheduled in {\tt MoL\_Register}. - \end{Discussion} - - \begin{SeeAlsoSection} - \begin{SeeAlso}{CCTK\_VarIndex()} - Get the variable index. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterEvolvedArray()} - Register evolved variables. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterSaveAndRestoreArray()} - Register Save and Restore variables. - \end{SeeAlso} - \begin{SeeAlso}{MoLChangeToConstrainedArray()} - Change a variable at runtime to be constrained. - \end{SeeAlso} - \end{SeeAlsoSection} - - \begin{ExampleSection} - \begin{Example}{C} -\begin{verbatim} -ierr = MoLRegisterConstrainedArray(CCTK_VarIndex("MyThorn::MyArray")); -\end{verbatim} - \end{Example} - \begin{Example}{Fortran} -\begin{verbatim} -call CCTK_VarIndex(ConstrainedIndex, "MyThorn::MyArray") -ierr = MoLRegisterConstrainedArray(ConstrainedIndex) -\end{verbatim} - \end{Example} - \end{ExampleSection} - -\end{FunctionDescription} - - - -\begin{FunctionDescription}{MoLRegisterSaveAndRestoreArray} - \label{MoLRegisterSaveAndRestoreArray} - - Tells MoL that the given \textbf{array} GF is in the Save and - Restore category. - - \begin{SynopsisSection} - \begin{Synopsis}{C} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterSaveAndRestoreArray(CCTK_INT SandRIndex) -\end{verbatim} - \end{Synopsis} - \begin{Synopsis}{Fortran} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterSaveAndRestoreArray(CCTK_INT SandRIndex) -\end{verbatim} - \end{Synopsis} - \end{SynopsisSection} - - \begin{ResultSection} - \begin{ResultNote} - Currently if there is an error, MoL will issue a level 0 - warning. No sensible return codes exist. - \end{ResultNote} - \begin{Result}{\rm 0} - success - \end{Result} - \end{ResultSection} - - \begin{ParameterSection} - \begin{Parameter}{SandRIndex} - Index of the Save and Restore \textbf{array}. - \end{Parameter} - \end{ParameterSection} - - \begin{Discussion} - Should be called in a function scheduled in {\tt MoL\_Register}. - \end{Discussion} - - \begin{SeeAlsoSection} - \begin{SeeAlso}{CCTK\_VarIndex()} - Get the variable index. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterEvolvedArray()} - Register evolved variables. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterConstrainedArray()} - Register constrained variables. - \end{SeeAlso} - \begin{SeeAlso}{MoLChangeToSaveAndRestoreArray()} - Change a variable at runtime to be Save and Restore. - \end{SeeAlso} - \end{SeeAlsoSection} - - \begin{ExampleSection} - \begin{Example}{C} -\begin{verbatim} -ierr = MoLRegisterSaveAndRestoreArray(CCTK_VarIndex("MyThorn::MyArray")); -\end{verbatim} - \end{Example} - \begin{Example}{Fortran} -\begin{verbatim} -call CCTK_VarIndex(SandRIndex, "MyThorn::MyArray") -ierr = MoLRegisterSaveAndRestoreArray(SandRIndex) -\end{verbatim} - \end{Example} - \end{ExampleSection} - -\end{FunctionDescription} - - - -\begin{FunctionDescription}{MoLRegisterEvolvedArrayGroup} - \label{MoLRegisterEvolvedArrayGroup} - - Tells MoL that the given \textbf{array} group is in the evolved - category with the associated update group. - - \begin{SynopsisSection} - \begin{Synopsis}{C} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterEvolvedArrayGroup(CCTK_INT EvolvedIndex, - CCTK_INT RHSIndex) -\end{verbatim} - \end{Synopsis} - \begin{Synopsis}{Fortran} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterEvolvedArrayGroup(CCTK_INT EvolvedIndex, - CCTK_INT RHSIndex) -\end{verbatim} - \end{Synopsis} - \end{SynopsisSection} - - \begin{ResultSection} - \begin{ResultNote} - Currently if there is an error, MoL will issue a level 0 - warning. No sensible return codes exist. - \end{ResultNote} - \begin{Result}{\rm 0} - success - \end{Result} - \end{ResultSection} - - \begin{ParameterSection} - \begin{Parameter}{EvolvedIndex} - Index of the \textbf{array} group to be evolved. - \end{Parameter} - \begin{Parameter}{RHSIndex} - Index of the associated update \textbf{array} group. - \end{Parameter} - \end{ParameterSection} - - \begin{Discussion} - Should be called in a function scheduled in {\tt MoL\_Register}. - \end{Discussion} - - \begin{SeeAlsoSection} - \begin{SeeAlso}{CCTK\_GroupIndex()} - Get the group index. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterSaveAndRestoreArrayGroup()} - Register Save and Restore variables. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterConstrainedArrayGroup()} - Register constrained variables. - \end{SeeAlso} - \end{SeeAlsoSection} - - \begin{ExampleSection} - \begin{Example}{C} -\begin{verbatim} -ierr = MoLRegisterEvolvedArrayGroup(CCTK_GroupIndex("MyThorn::MyArray"), - CCTK_GroupIndex("MyThorn::MyArrayRHS")); -\end{verbatim} - \end{Example} - \begin{Example}{Fortran} -\begin{verbatim} -call CCTK_GroupIndex(EvolvedIndex, "MyThorn::MyArray") -call CCTK_GroupIndex(RHSIndex, "MyThorn::MyArrayRHS") -ierr = MoLRegisterEvolvedArrayGroup(EvolvedIndex, RHSIndex) -\end{verbatim} - \end{Example} - \end{ExampleSection} - -\end{FunctionDescription} - - - -\begin{FunctionDescription}{MoLRegisterConstrainedArrayGroup} - \label{MoLRegisterConstrainedArrayGroup} - - Tells MoL that the given \textbf{array} group is in the constrained - category. - - \begin{SynopsisSection} - \begin{Synopsis}{C} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterConstrainedArrayGroup(CCTK_INT ConstrainedIndex) -\end{verbatim} - \end{Synopsis} - \begin{Synopsis}{Fortran} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterConstrainedArrayGroup(CCTK_INT ConstrainedIndex) -\end{verbatim} - \end{Synopsis} - \end{SynopsisSection} - - \begin{ResultSection} - \begin{ResultNote} - Currently if there is an error, MoL will issue a level 0 - warning. No sensible return codes exist. - \end{ResultNote} - \begin{Result}{\rm 0} - success - \end{Result} - \end{ResultSection} - - \begin{ParameterSection} - \begin{Parameter}{ConstrainedIndex} - Index of the constrained \textbf{array} group. - \end{Parameter} - \end{ParameterSection} - - \begin{Discussion} - Should be called in a function scheduled in {\tt MoL\_Register}. - \end{Discussion} - - \begin{SeeAlsoSection} - \begin{SeeAlso}{CCTK\_GroupIndex()} - Get the group index. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterEvolvedArrayGroup()} - Register evolved variables. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterSaveAndRestoreArrayGroup()} - Register Save and Restore variables. - \end{SeeAlso} - \begin{SeeAlso}{MoLChangeToConstrainedArray()} - Change a variable at runtime to be constrained. - \end{SeeAlso} - \end{SeeAlsoSection} - - \begin{ExampleSection} - \begin{Example}{C} -\begin{verbatim} -ierr = MoLRegisterConstrainedGroupArray(CCTK_VarIndex("MyThorn::MyArray")); -\end{verbatim} - \end{Example} - \begin{Example}{Fortran} -\begin{verbatim} -call CCTK_GroupIndex(ConstrainedIndex, "MyThorn::MyArray") -ierr = MoLRegisterConstrainedArrayGroup(ConstrainedIndex) -\end{verbatim} - \end{Example} - \end{ExampleSection} - -\end{FunctionDescription} - - - -\begin{FunctionDescription}{MoLRegisterSaveAndRestoreArrayGroup} - \label{MoLRegisterSaveAndRestoreArrayGroup} - - Tells MoL that the given \textbf{array} group is in the Save and - Restore category. - - \begin{SynopsisSection} - \begin{Synopsis}{C} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterSaveAndRestoreArrayGroup(CCTK_INT SandRIndex) -\end{verbatim} - \end{Synopsis} - \begin{Synopsis}{Fortran} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterSaveAndRestoreArrayGroup(CCTK_INT SandRIndex) -\end{verbatim} - \end{Synopsis} - \end{SynopsisSection} - - \begin{ResultSection} - \begin{ResultNote} - Currently if there is an error, MoL will issue a level 0 - warning. No sensible return codes exist. - \end{ResultNote} - \begin{Result}{\rm 0} - success - \end{Result} - \end{ResultSection} - - \begin{ParameterSection} - \begin{Parameter}{SandRIndex} - Index of the save and restore group. - \end{Parameter} - \end{ParameterSection} - - \begin{Discussion} - Should be called in a function scheduled in {\tt MoL\_Register}. - \end{Discussion} - - \begin{SeeAlsoSection} - \begin{SeeAlso}{CCTK\_GroupIndex()} - Get the group index. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterEvolvedArrayGroup()} - Register evolved variables. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterConstrainedArrayGroup()} - Register constrained variables. - \end{SeeAlso} - \end{SeeAlsoSection} - - \begin{ExampleSection} - \begin{Example}{C} -\begin{verbatim} -ierr = MoLRegisterSaveAndRestoreArrayGroup(CCTK_GroupIndex("MyThorn::MyArray")); -\end{verbatim} - \end{Example} - \begin{Example}{Fortran} -\begin{verbatim} -call CCTK_GroupIndex(SandRIndex, "MyThorn::MyArray") -ierr = MoLRegisterSaveAndRestoreArrayGroup(SandRIndex) -\end{verbatim} - \end{Example} - \end{ExampleSection} - -\end{FunctionDescription} - - -\begin{FunctionDescription}{MoLRegisterEvolvedComplexArray} - \label{MoLRegisterEvolvedComplexArray} - - Tells MoL that the given \textbf{complex array} is in the evolved - category with the associated update \textbf{complex array}. - - \begin{SynopsisSection} - \begin{Synopsis}{C} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterEvolvedComplexArray(CCTK_INT EvolvedIndex, - CCTK_INT RHSIndex) -\end{verbatim} - \end{Synopsis} - \begin{Synopsis}{Fortran} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterEvolvedComplexArray(CCTK_INT EvolvedIndex, - CCTK_INT RHSIndex) -\end{verbatim} - \end{Synopsis} - \end{SynopsisSection} - - \begin{ResultSection} - \begin{ResultNote} - Currently if there is an error, MoL will issue a level 0 - warning. No sensible return codes exist. - \end{ResultNote} - \begin{Result}{\rm 0} - success - \end{Result} - \end{ResultSection} - - \begin{ParameterSection} - \begin{Parameter}{EvolvedIndex} - Index of the \textbf{complex array} to be evolved. - \end{Parameter} - \begin{Parameter}{RHSIndex} - Index of the associated update \textbf{complex array}. - \end{Parameter} - \end{ParameterSection} - - \begin{Discussion} - Should be called in a function scheduled in {\tt MoL\_Register}. - \end{Discussion} - - \begin{SeeAlsoSection} - \begin{SeeAlso}{CCTK\_VarIndex()} - Get the variable index. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterSaveAndRestoreComplexArray()} - Register Save and Restore variables. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterConstrainedComplexArray()} - Register constrained variables. - \end{SeeAlso} - \begin{SeeAlso}{MoLChangeToEvolvedComplexArray()} - Change a variable at runtime to be evolved. - \end{SeeAlso} - \end{SeeAlsoSection} - - \begin{ExampleSection} - \begin{Example}{C} -\begin{verbatim} -ierr = MoLRegisterEvolvedComplexArray(CCTK_VarIndex("MyThorn::MyComplexArray"), - CCTK_VarIndex("MyThorn::MyComplexArrayRHS")); -\end{verbatim} - \end{Example} - \begin{Example}{Fortran} -\begin{verbatim} -call CCTK_VarIndex(EvolvedIndex, "MyThorn::MyComplexArray") -call CCTK_VarIndex(RHSIndex, "MyThorn::MyComplexArrayRHS") -ierr = MoLRegisterEvolvedComplexArray(EvolvedIndex, RHSIndex) -\end{verbatim} - \end{Example} - \end{ExampleSection} - -\end{FunctionDescription} - - - -\begin{FunctionDescription}{MoLRegisterConstrainedComplexArray} - \label{MoLRegisterConstrainedComplexArray} - - Tells MoL that the given \textbf{complex array} is in the - constrained category. - - \begin{SynopsisSection} - \begin{Synopsis}{C} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterConstrainedComplexArray(CCTK_INT ConstrainedIndex) -\end{verbatim} - \end{Synopsis} - \begin{Synopsis}{Fortran} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterConstrainedComplexArray(CCTK_INT ConstrainedIndex) -\end{verbatim} - \end{Synopsis} - \end{SynopsisSection} - - \begin{ResultSection} - \begin{ResultNote} - Currently if there is an error, MoL will issue a level 0 - warning. No sensible return codes exist. - \end{ResultNote} - \begin{Result}{\rm 0} - success - \end{Result} - \end{ResultSection} - - \begin{ParameterSection} - \begin{Parameter}{ConstrainedIndex} - Index of the constrained \textbf{complex array}. - \end{Parameter} - \end{ParameterSection} - - \begin{Discussion} - Should be called in a function scheduled in {\tt MoL\_Register}. - \end{Discussion} - - \begin{SeeAlsoSection} - \begin{SeeAlso}{CCTK\_VarIndex()} - Get the variable index. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterEvolvedComplexArray()} - Register evolved variables. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterSaveAndRestoreComplexArray()} - Register Save and Restore variables. - \end{SeeAlso} - \begin{SeeAlso}{MoLChangeToConstrainedComplexArray()} - Change a variable at runtime to be constrained. - \end{SeeAlso} - \end{SeeAlsoSection} - - \begin{ExampleSection} - \begin{Example}{C} -\begin{verbatim} -ierr = MoLRegisterConstrainedComplexArray(CCTK_VarIndex("MyThorn::MyComplexArray")); -\end{verbatim} - \end{Example} - \begin{Example}{Fortran} -\begin{verbatim} -call CCTK_VarIndex(ConstrainedIndex, "MyThorn::MyComplexArray") -ierr = MoLRegisterConstrainedComplexArray(ConstrainedIndex) -\end{verbatim} - \end{Example} - \end{ExampleSection} - -\end{FunctionDescription} - - - -\begin{FunctionDescription}{MoLRegisterSaveAndRestoreComplexArray} - \label{MoLRegisterSaveAndRestoreComplexArray} - - Tells MoL that the given \textbf{complex array} is in the Save and - Restore category. - - \begin{SynopsisSection} - \begin{Synopsis}{C} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterSaveAndRestoreComplexArray(CCTK_INT SandRIndex) -\end{verbatim} - \end{Synopsis} - \begin{Synopsis}{Fortran} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterSaveAndRestoreComplexArray(CCTK_INT SandRIndex) -\end{verbatim} - \end{Synopsis} - \end{SynopsisSection} - - \begin{ResultSection} - \begin{ResultNote} - Currently if there is an error, MoL will issue a level 0 - warning. No sensible return codes exist. - \end{ResultNote} - \begin{Result}{\rm 0} - success - \end{Result} - \end{ResultSection} - - \begin{ParameterSection} - \begin{Parameter}{SandRIndex} - Index of the Save and Restore \textbf{complex array}. - \end{Parameter} - \end{ParameterSection} - - \begin{Discussion} - Should be called in a function scheduled in {\tt MoL\_Register}. - \end{Discussion} - - \begin{SeeAlsoSection} - \begin{SeeAlso}{CCTK\_VarIndex()} - Get the variable index. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterEvolvedComplexArray()} - Register evolved variables. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterConstrainedComplexArray()} - Register constrained variables. - \end{SeeAlso} - \begin{SeeAlso}{MoLChangeToSaveAndRestoreComplexArray()} - Change a variable at runtime to be Save and Restore. - \end{SeeAlso} - \end{SeeAlsoSection} - - \begin{ExampleSection} - \begin{Example}{C} -\begin{verbatim} -ierr = MoLRegisterSaveAndRestoreComplexArray(CCTK_VarIndex("MyThorn::MyComplexArray")); -\end{verbatim} - \end{Example} - \begin{Example}{Fortran} -\begin{verbatim} -call CCTK_VarIndex(SandRIndex, "MyThorn::MyComplexArray") -ierr = MoLRegisterSaveAndRestoreComplexArray(SandRIndex) -\end{verbatim} - \end{Example} - \end{ExampleSection} - -\end{FunctionDescription} - - - -\begin{FunctionDescription}{MoLRegisterEvolvedComplexArrayGroup} - \label{MoLRegisterEvolvedComplexArrayGroup} - - Tells MoL that the given \textbf{complex array} group is in the - evolved category with the associated update group. - - \begin{SynopsisSection} - \begin{Synopsis}{C} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterEvolvedComplexArrayGroup(CCTK_INT EvolvedIndex, - CCTK_INT RHSIndex) -\end{verbatim} - \end{Synopsis} - \begin{Synopsis}{Fortran} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterEvolvedComplexArrayGroup(CCTK_INT EvolvedIndex, - CCTK_INT RHSIndex) -\end{verbatim} - \end{Synopsis} - \end{SynopsisSection} - - \begin{ResultSection} - \begin{ResultNote} - Currently if there is an error, MoL will issue a level 0 - warning. No sensible return codes exist. - \end{ResultNote} - \begin{Result}{\rm 0} - success - \end{Result} - \end{ResultSection} - - \begin{ParameterSection} - \begin{Parameter}{EvolvedIndex} - Index of the \textbf{complex array} group to be evolved. - \end{Parameter} - \begin{Parameter}{RHSIndex} - Index of the associated update \textbf{complex array} group. - \end{Parameter} - \end{ParameterSection} - - \begin{Discussion} - Should be called in a function scheduled in {\tt MoL\_Register}. - \end{Discussion} - - \begin{SeeAlsoSection} - \begin{SeeAlso}{CCTK\_GroupIndex()} - Get the group index. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterSaveAndRestoreComplexArrayGroup()} - Register Save and Restore variables. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterConstrainedComplexArrayGroup()} - Register constrained variables. - \end{SeeAlso} - \end{SeeAlsoSection} - - \begin{ExampleSection} - \begin{Example}{C} -\begin{verbatim} -ierr = MoLRegisterEvolvedComplexArrayGroup(CCTK_GroupIndex("MyThorn::MyComplexArray"), - CCTK_GroupIndex("MyThorn::MyComplexArrayRHS")); -\end{verbatim} - \end{Example} - \begin{Example}{Fortran} -\begin{verbatim} -call CCTK_GroupIndex(EvolvedIndex, "MyThorn::MyComplexArray") -call CCTK_GroupIndex(RHSIndex, "MyThorn::MyComplexArrayRHS") -ierr = MoLRegisterEvolvedComplexArrayGroup(EvolvedIndex, RHSIndex) -\end{verbatim} - \end{Example} - \end{ExampleSection} - -\end{FunctionDescription} - - - -\begin{FunctionDescription}{MoLRegisterConstrainedComplexArrayGroup} - \label{MoLRegisterConstrainedComplexArrayGroup} - - Tells MoL that the given \textbf{complex array} group is in the constrained category. - - \begin{SynopsisSection} - \begin{Synopsis}{C} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterConstrainedComplexArrayGroup(CCTK_INT ConstrainedIndex) -\end{verbatim} - \end{Synopsis} - \begin{Synopsis}{Fortran} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterConstrainedComplexArrayGroup(CCTK_INT ConstrainedIndex) -\end{verbatim} - \end{Synopsis} - \end{SynopsisSection} - - \begin{ResultSection} - \begin{ResultNote} - Currently if there is an error, MoL will issue a level 0 - warning. No sensible return codes exist. - \end{ResultNote} - \begin{Result}{\rm 0} - success - \end{Result} - \end{ResultSection} - - \begin{ParameterSection} - \begin{Parameter}{ConstrainedIndex} - Index of the constrained \textbf{complex array} group. - \end{Parameter} - \end{ParameterSection} - - \begin{Discussion} - Should be called in a function scheduled in {\tt MoL\_Register}. - \end{Discussion} - - \begin{SeeAlsoSection} - \begin{SeeAlso}{CCTK\_GroupIndex()} - Get the group index. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterEvolvedComplexArrayGroup()} - Register evolved variables. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterSaveAndRestoreComplexArrayGroup()} - Register Save and Restore variables. - \end{SeeAlso} - \begin{SeeAlso}{MoLChangeToConstrainedComplexArray()} - Change a variable at runtime to be constrained. - \end{SeeAlso} - \end{SeeAlsoSection} - - \begin{ExampleSection} - \begin{Example}{C} -\begin{verbatim} -ierr = MoLRegisterConstrainedGroupComplexArray(CCTK_VarIndex("MyThorn::MyComplexArray")); -\end{verbatim} - \end{Example} - \begin{Example}{Fortran} -\begin{verbatim} -call CCTK_GroupIndex(ConstrainedIndex, "MyThorn::MyComplexArray") -ierr = MoLRegisterConstrainedComplexArrayGroup(ConstrainedIndex) -\end{verbatim} - \end{Example} - \end{ExampleSection} - -\end{FunctionDescription} - - - -\begin{FunctionDescription}{MoLRegisterSaveAndRestoreComplexArrayGroup} - \label{MoLRegisterSaveAndRestoreComplexArrayGroup} - - Tells MoL that the given \textbf{complex array} group is in the Save - and Restore category. - - \begin{SynopsisSection} - \begin{Synopsis}{C} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterSaveAndRestoreComplexArrayGroup(CCTK_INT SandRIndex) -\end{verbatim} - \end{Synopsis} - \begin{Synopsis}{Fortran} -\begin{verbatim} -CCTK_INT ierr = MoLRegisterSaveAndRestoreComplexArrayGroup(CCTK_INT SandRIndex) -\end{verbatim} - \end{Synopsis} - \end{SynopsisSection} - - \begin{ResultSection} - \begin{ResultNote} - Currently if there is an error, MoL will issue a level 0 - warning. No sensible return codes exist. - \end{ResultNote} - \begin{Result}{\rm 0} - success - \end{Result} - \end{ResultSection} - - \begin{ParameterSection} - \begin{Parameter}{SandRIndex} - Index of the save and restore group. - \end{Parameter} - \end{ParameterSection} - - \begin{Discussion} - Should be called in a function scheduled in {\tt MoL\_Register}. - \end{Discussion} - - \begin{SeeAlsoSection} - \begin{SeeAlso}{CCTK\_GroupIndex()} - Get the group index. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterEvolvedComplexArrayGroup()} - Register evolved variables. - \end{SeeAlso} - \begin{SeeAlso}{MoLRegisterConstrainedComplexArrayGroup()} - Register constrained variables. - \end{SeeAlso} - \end{SeeAlsoSection} - - \begin{ExampleSection} - \begin{Example}{C} -\begin{verbatim} -ierr = MoLRegisterSaveAndRestoreComplexArrayGroup(CCTK_GroupIndex("MyThorn::MyComplexArray")); -\end{verbatim} - \end{Example} - \begin{Example}{Fortran} -\begin{verbatim} -call CCTK_GroupIndex(SandRIndex, "MyThorn::MyComplexArray") -ierr = MoLRegisterSaveAndRestoreComplexArrayGroup(SandRIndex) -\end{verbatim} - \end{Example} - \end{ExampleSection} - -\end{FunctionDescription} - \begin{thebibliography}{9} \bibitem{AlphaThorns_MoL_Thornburg93} |