Changeset ef85a09 in sasmodels for doc/guide/plugin.rst

Timestamp:

Dec 14, 2017 4:07:26 PM (6 years ago)

Author:

Paul Kienzle <pkienzle@…>

Branches:

master, core_shell_microgels, magnetic_model, ticket-1257-vesicle-product, ticket_1156, ticket_1265_superball, ticket_822_more_unit_tests

Children:

b85227d

Parents:

108e70e

Message:

document the new c_code='…' model definition option

File:

• doc/guide/plugin.rst (modified) (2 diffs)

doc/guide/plugin.rst

@@ -499 +499 @@
 **source=['fn.c', ...]** includes the listed C source files in the
 program before *Iq* and *form_volume* are defined. This allows you to
-extend the library of C functions available to your model.  Note that
+extend the library of C functions available to your model.
+
+*c_code* includes arbitrary C code into your kernel, which can be
+handy for defining helper functions for *Iq* and *form_volume*. Note that
 you can put the full function definition for *Iq* and *form_volume*
-(include function declaration) into an external C file and add it to the list
-of sources instead of defining it within the python model file.
+(include function declaration) into *c_code* as well, or put them into an
+external C file and add that file to the list of sources.
 
 Models are defined using double precision declarations for the
@@ -526 +529 @@
 
     #define INVALID(v) (v.bell_radius < v.radius)
+
+The INVALID define can go into *Iq*, or *c_code*, or an external C file
+listed in *source*.
 
 Oriented Shapes