next up previous contents
Next: Extending the standard CLASS Up: Adding hooks to the Previous: API   Contents

API summary

The table 1 describes the general hooks to be used in order to read or write the User Section. They have to be considered as prerequisites before doing anything with this section in CLASS.




Table 1: General hooks
Subroutine Purpose
class_user_owner declare who is the owner and what is the title of the subsection the hooks can read or write

The table 2 describe the hooks to be used when adding a User Section to an observation (e.g. before writing it to the output file).




Table 2: Writing hooks
Subroutine Purpose
class_user_add add a new user subsection to the input observation
class_user_update update a user subsection which already exists
class_user_toclass declare the subroutine which will write the data to the Class internal buffer
class_user_datatoclass transfer a scalar or 1D-array value to the Class internal buffer (generic subroutine)

Finally the table 3 summarizes the subroutines which can be used to declare the hooks to some CLASS commands, plus some subroutines which are useful for some of them.




Table 3: Reading hooks
Subroutine Purpose
class_user_dump declare the hook for the command DUMP
class_user_find declare the hook for the command FIND /USER (command line parsing)
class_user_fix declare the hook for the command FIND /USER (selection)
class_user_setvar declare the hook for the command SET VARIABLE USER
class_user_classtodata read a scalar or 1D-array value from the Class internal buffer (generic subroutine)
class_user_def_inte create an integer*4 SIC variable in the structure R%USER%OWNER%
class_user_def_real create a real*4 SIC variable in the structure R%USER%OWNER%
class_user_def_dble create a real*8 SIC variable in the structure R%USER%OWNER%
class_user_def_char create a character string SIC variable in the structure R%USER%OWNER%


next up previous contents
Next: Extending the standard CLASS Up: Adding hooks to the Previous: API   Contents
Gildas manager 2014-07-01