The SPARK Atomic Class API

VisualSPARK 2.01

This document describes the preprocessor macro definitions, classes and functions that are used to implement the inverses in the user-defined atomic classes. The macros and functions are declared in the header file spark.h. After installation of the VisualSPARK release package, the header file spark.h can be found in the inc/ subdirectory in the main SPARK directory.

The header file spark.h should be included in every file where user-defined atomic classes are implemented to ensure that the required declarations are provided correctly at compile-time.

More detailed information about how to write an atomic class can be found in:

• the SPARK Reference Manual
• the VisualSPARK Users Guide
• the VisualSPARK tutorial

Visit http://simulationresearch.lbl.gov/ to obtain the latest versions of these documents.

List of preprocessor macros

Macros to declare the callback prototypes:

• NON_MODIFIER_CALLBACK( func )
• MODIFIER_CALLBACK( func )
• PREDICATE_CALLBACK( func )
• STATIC_NON_MODIFIER_CALLBACK( func )
• STATIC_PREDICATE_CALLBACK( func )

Macros to declare each callback type:

• EVALUATE( func )
• PREDICT( func )

• CONSTRUCT( func )
• PREPARE_STEP( func )
• CHECK_INTEGRATION_STEP( func )
• COMMIT( func )
• ROLLBACK( func )
• DESTRUCT( func )

• STATIC_CONSTRUCT( func )
• STATIC_PREPARE_STEP( func )
• STATIC_CHECK_INTEGRATION_STEP( func )
• STATIC_COMMIT( func )
• STATIC_ROLLBACK( func )
• STATIC_DESTRUCT( func )

Macros to manage private data associated with each object and/or inverse:

• THIS

• GET_DATA
• SET_DATA
• DELETE_DATA

• ACTIVE_PROBLEM
• ACTIVE_INVERSE
• ACTIVE_COMPONENT

Macros to manage the argument variables passed to a callback:

• ARGUMENT( n, Name )
• ARGDEF( n , Name )

Macros to manage the target variables returned from a callback:

• TARGET( n, Name )
• RETURN( val )

Macros to send a problem request from an atomic class:

• REQUEST__ABORT( context )

• REQUEST__STOP( context )
• REQUEST__SET_STOP_TIME( context, time )

• REQUEST__REPORT( context )
• REQUEST__SNAPSHOT( context, filename )

• REQUEST__SET_MEETING_POINT( context, time )
• REQUEST__CLEAR_MEETING_POINTS( context )

• REQUEST__RESTART( context )
• REQUEST__SET_TIME_STEP( context, h )

List of classes and typedefs

The following classes:

• SPARK::TVariable
• SPARK::TUnknown
• SPARK::TArgument
• SPARK::TTarget

used to represent the problem variables in the SPARK solver have also been documented. They are defined in the header files variable.h and callback.h which can be found in the inc/ subdirectory.

Finally, the classes that implement the callbacks, inverses and objects are described:

• SPARK::TInverse
• SPARK::TObject
• SPARK::TModifierCallback
• SPARK::TNonModifierCallback
• SPARK::TPredicateCallback
• SPARK::TStaticNonModifierCallback
• SPARK::TStaticPredicateCallback

---