summaryrefslogtreecommitdiff
path: root/doc/ReferenceManual
Commit message (Collapse)AuthorAge
* commit typo in function name of strtolrhaas2013-08-04
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@5038 17b73243-c579-4c4c-a9d2-2d5706c11dac
* refer to 'index' argument in CCTK_VarTypeI as 'variable index'rhaas2013-06-05
| | | | | | | rather than 'group' git-svn-id: http://svn.cactuscode.org/flesh/trunk@5023 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Add separate pages of documentation for CCTK_Error, CCTK_Info, CCTK_Warnrhaas2013-05-18
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@5013 17b73243-c579-4c4c-a9d2-2d5706c11dac
* add documentation for util_asprintfrhaas2013-05-11
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@5008 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Correct documenation of CCTK_Aborteschnett2013-03-05
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4975 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Implement CCTK_Error and friendseschnett2013-02-26
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4964 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Documentation for CCTK_TimerRunning and CCTK_TimerRunningIknarf2012-10-24
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4891 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Remove appendices from reference manualeschnett2012-10-21
| | | | | | | | | These appendices are already in the users' guide. Also re-instate references that were commented out. git-svn-id: http://svn.cactuscode.org/flesh/trunk@4880 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Correct Fortran example for CCTK_Equalseschnett2012-10-21
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4878 17b73243-c579-4c4c-a9d2-2d5706c11dac
* correct and expand documentation of CCTK_TraverseStringrhaas2012-09-06
| | | | | | | | by listing the possible values for selection and correcting the return type of the callback function to void rather than int. git-svn-id: http://svn.cactuscode.org/flesh/trunk@4866 17b73243-c579-4c4c-a9d2-2d5706c11dac
* include documentation on Fortran interface of CCTK_VarDataPtrrhaas2012-08-11
| | | | | | | as well as a typo in the ScheduleQueryCurrentFunction example git-svn-id: http://svn.cactuscode.org/flesh/trunk@4861 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Correct description of CCTK_LocalArrayReductionHandleeschnett2012-08-02
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4855 17b73243-c579-4c4c-a9d2-2d5706c11dac
* add documentation for CCTK_TraverseStringrhaas2012-07-17
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4846 17b73243-c579-4c4c-a9d2-2d5706c11dac
* CCTKReference.tex: Add information on vector variables to CCTK_VarIndexhinder2012-07-06
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4842 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Introduce cctk_ash, retire cctk_lssheschnett2012-07-04
| | | | | | | | | | | | Introduce cctk_ash, describing the process-local array shape that has been allocated. This may be larger than cctk_lsh, the process-local shape that should be used. Retire cctk_lssh and related infrastructure to handle staggered grid functions. git-svn-id: http://svn.cactuscode.org/flesh/trunk@4841 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Add missing lssh field to struct cGroupDynamicDataeschnett2012-06-11
| | | | | | | | | The size and memory layout of grid functions is described by two variables, cctk_lsh and cctk_lssh. The structure cGroupDynamicData is missing the lssh field. git-svn-id: http://svn.cactuscode.org/flesh/trunk@4833 17b73243-c579-4c4c-a9d2-2d5706c11dac
* have CCTK_RegexMatch return a distinct error code if patterns is invalidrhaas2012-06-05
| | | | | | | | | | | | | | This patch changes the return value in the "does not compile" case to -1 and updates all source files that I could find that use it. Note that this patch changes behaviour of a routine. It used to return 0 for non-compiling patterns so thorns that test for C-like true would interpret invalid patterns as does-not-match, but will interpret the -1 return value as does-match. git-svn-id: http://svn.cactuscode.org/flesh/trunk@4831 17b73243-c579-4c4c-a9d2-2d5706c11dac
* add function to query name of currently scheduled functionrhaas2012-04-23
| | | | | | | | | | this adds a function CCTK_ScheduleQueryCurrentFunction which returns the cFunctionData of the function currently executing via CCTK_CallScheduledFunction git-svn-id: http://svn.cactuscode.org/flesh/trunk@4805 17b73243-c579-4c4c-a9d2-2d5706c11dac
* fix prototype of CCTK_Barrier in reference manualrhaas2012-03-27
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4796 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Removed RCSfile tag that appeared in the bottom left of many pages.sbrandt2012-01-12
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4782 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Make table printing functions publicly accessibleeschnett2011-11-09
| | | | | | | | | | | | The table data types (util_Table.h) have internal routines that print the table contents to screen. This can be helpful for debugging. This patch makes these functions publicly available. Add a routine Util_TablePrintPretty that converts a table to a nice, human-readable string. git-svn-id: http://svn.cactuscode.org/flesh/trunk@4769 17b73243-c579-4c4c-a9d2-2d5706c11dac
* doc: Remove revision and date from front page in manualshinder2011-10-25
| | | | | | | | | | | | This was giving the revision and date of the UsersGuide.tex file etc, and not the date of the last edit to the documentation. Hence it was giving the impression that our documentation came from 2004. Better to have no date. This technique also worked only in SVN, and stopped people from using git-svn. git-svn-id: http://svn.cactuscode.org/flesh/trunk@4758 17b73243-c579-4c4c-a9d2-2d5706c11dac
* document CCTK_ReduceArraysGlobally for fortan in section for ↵knarf2011-09-25
| | | | | | CCTK_ReduceArraysGlobally, not CCTK_ReduceGridArrays git-svn-id: http://svn.cactuscode.org/flesh/trunk@4730 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Correct documentation of Fortran IsImplementationActive prototypeeschnett2011-09-15
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4724 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Update documentation of CCTK_ParameterSeteschnett2010-10-04
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4641 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Correct routine nameeschnett2010-09-17
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4636 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Patch from Barry Wardell, thanks:knarf2010-06-03
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Enables support for compiling HTML versions of the Cactus documentation. It adds new build targets: ReferenceManualHTML MaintainersGuideHTML UsersGuideHTML *-ThornDocHTML *-ArrangementDocHTML ThornDocHTML ArrangementDocHTML ThornGuideHTML Which are HTML equivalents of the existing doc targets. This makes use of the small new scripts lib/sbin/ArrangementDocHTML and lib/sbin/ThornDocHTML. This patch also introduces a small new script, lib/sbin/ConvertFigures, which automates the process of converting figures to the correct format for htlatex. Finally, it makes some changes to doc/latex/cactus.sty to improve the rendering of the HTML. It also modifies the Reference Guide to produce a more consistent result (any cases of the CCTKFunc macro were updated to use the newer FunctionDescriptionEntry). git-svn-id: http://svn.cactuscode.org/flesh/trunk@4621 17b73243-c579-4c4c-a9d2-2d5706c11dac
* correct datatype of string_length argument (from integer to CCTK_INT)tradke2009-01-28
| | | | | | | in Fortran wrapper of CCTK_FortranString() git-svn-id: http://svn.cactuscode.org/flesh/trunk@4529 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Create documentation exclusively in pdf. No postscript or dvi isschnetter2009-01-26
| | | | | | | | | produced. Remove .eps files. git-svn-id: http://svn.cactuscode.org/flesh/trunk@4522 17b73243-c579-4c4c-a9d2-2d5706c11dac
* remove (comment) broken referencesknarf2009-01-22
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4514 17b73243-c579-4c4c-a9d2-2d5706c11dac
* added missing function descriptions for CCTK_GroupDimI(),tradke2008-09-19
| | | | | | | CCTK_GroupDimFromVarI(), CCTK_GroupSizes(), and CCTK_GroupGhostsizes() git-svn-id: http://svn.cactuscode.org/flesh/trunk@4506 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Correct description of CCTK_GroupStorageDecreaseschnetter2008-04-09
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4480 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Add a new function CCTK_MaxGFDim to the flesh which returns theschnetter2008-04-07
| | | | | | | | | | | | | | | | | (maximum) dimension of all grid functions. Cactus can currently not handle the case where one uses grid arrays of dimension D while grid functions have a dimension less than D. During initialisation, Cactus sets cctk_dim to the largest dimension of all grid variables in all active thorns. This is arguably wrong; cctk_dim should be set to the (maximum) dimension of the grid functions. This patch adds a new function CCTK_MaxGFDim to the flesh which returns the (maximum) dimension of all grid functions. This function is used to set cctk_dim. git-svn-id: http://svn.cactuscode.org/flesh/trunk@4476 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Update email and postal address of Cactus team from AEI to CCTschnetter2008-03-20
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4473 17b73243-c579-4c4c-a9d2-2d5706c11dac
* /tmp/cvsNXUw0htradke2008-03-17
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4471 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Clarify entry CCTK_InterpGridArrays. Speak of "grid variables"schnetter2008-02-09
| | | | | | | | | | instead of "grid array", since grid functions can also be interpolated. Add entry for CCTK_SchedulePrintTimes. git-svn-id: http://svn.cactuscode.org/flesh/trunk@4458 17b73243-c579-4c4c-a9d2-2d5706c11dac
* wording tweak to last commit --- thanks to Thomas Radkejthorn2007-01-12
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4400 17b73243-c579-4c4c-a9d2-2d5706c11dac
* document the semantics ofjthorn2007-01-12
| | | | | | | | | | CCTK_MyProc(NULL) CCTK_nProcs(NULL) as per the thread starting with http://www.cactuscode.org/old/pipermail/developers/2007-January/005227.html git-svn-id: http://svn.cactuscode.org/flesh/trunk@4399 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Document new flesh API functions CCTK_ParameterSetNotifyRegister() andtradke2006-09-28
| | | | | | | CCTK_ParameterSetNotifyUnregister(). git-svn-id: http://svn.cactuscode.org/flesh/trunk@4376 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Removed duplicate entries for Util_TableSetInt() and Util_TableSetReal().tradke2006-09-04
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4373 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Document Util_CurrentDate(), Util_CurrentTime(), Util_CurrentDateTime(),tradke2006-07-28
| | | | | | | CCTK_CompileDate(), CCTK_CompileTime(), CCTK_CompileDateTime(). git-svn-id: http://svn.cactuscode.org/flesh/trunk@4359 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Added missing documentation for CCTK_SyncGroupsI().tradke2006-06-30
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4338 17b73243-c579-4c4c-a9d2-2d5706c11dac
* permute order of entries forjthorn2006-05-31
| | | | | | | | | | | CCTK_MaxTimeLevelsGI() CCTK_MaxTimeLevelsGN() CCTK_MaxTimeLevelsVI() CCTK_MaxTimeLevelsVN() to be in alphabetical order (and all come before CCTK_MyProc()) git-svn-id: http://svn.cactuscode.org/flesh/trunk@4309 17b73243-c579-4c4c-a9d2-2d5706c11dac
* move CCTK_MyProc entry to its proper place for alphabetical orderjthorn2006-05-31
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4308 17b73243-c579-4c4c-a9d2-2d5706c11dac
* clarify distinction between CCTK_SyncGroup() and CCTK_SyncGroupI()jthorn2006-05-30
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4305 17b73243-c579-4c4c-a9d2-2d5706c11dac
* += (the previously-undocumented function) CCTK_SyncGroupI()jthorn2006-05-30
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4304 17b73243-c579-4c4c-a9d2-2d5706c11dac
* redo description of CCTK_SyncGroup()jthorn2006-05-26
| | | | | | | | | | | * use modern FunctionDescription environment * document that GH argument is pointer-to-const (i.e. document that CCTK_SyncGroup doesn't modify the GH) * document that this is a collective operation * add an example git-svn-id: http://svn.cactuscode.org/flesh/trunk@4302 17b73243-c579-4c4c-a9d2-2d5706c11dac
* document the previously-undocumented flesh APIsjthorn2006-05-14
| | | | | | | CCTK_GroupTagsTable() and CCTK_GroupTagsTableI() git-svn-id: http://svn.cactuscode.org/flesh/trunk@4297 17b73243-c579-4c4c-a9d2-2d5706c11dac
* replace a PUGH_ with CCTK_ (in a CCTK function name)rideout2006-02-24
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4261 17b73243-c579-4c4c-a9d2-2d5706c11dac
* Added missing synopsis for Fortran routine CCTK_InterpLocalUniform.tradke2006-02-14
| | | | git-svn-id: http://svn.cactuscode.org/flesh/trunk@4254 17b73243-c579-4c4c-a9d2-2d5706c11dac