ctrxn.h File Reference

CTRXN - Generated CLib Cantera interface library. More...

Detailed Description

CTRXN - Generated CLib Cantera interface library.

Generated CLib API for Cantera's Reaction class.

This library of functions is designed to encapsulate Cantera functionality and make it available for use in languages and applications other than C++. A set of library functions is provided that are declared "extern C". All Cantera objects are stored and referenced by integers - no pointers are passed to or from the calling application.

This file was generated by sourcegen. It will be re-generated by the Cantera build process. Do not manually edit.

Warning

This library is an experimental part of the Cantera API and may be changed without notice.

Definition in file ctrxn.h.

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
int32_t	rxn_new ()
	Instantiate Reaction object using default constructor.
int32_t	rxn_equation (int32_t handle, int32_t bufLen, char *buf)
	The chemical equation for this reaction.
int32_t	rxn_type (int32_t handle, int32_t bufLen, char *buf)
	The type of reaction, including reaction rate information.
int32_t	rxn_usesThirdBody (int32_t handle)
	Check whether reaction involves third body collider.
int32_t	rxn_valid (int32_t handle)
	Get validity flag of reaction.
int32_t	rxn_id (int handle, int32_t bufLen, char *buf)
	An identification string for the reaction, used in some filtering operations.
int32_t	rxn_setId (int32_t handle, const char *id)
	An identification string for the reaction, used in some filtering operations.
int32_t	rxn_allowNonreactantOrders (int handle)
	True if reaction orders can be specified for non-reactant species.
int32_t	rxn_setAllowNonreactantOrders (int32_t handle, int32_t allow_nonreactant_orders)
	True if reaction orders can be specified for non-reactant species.
int32_t	rxn_del (int32_t handle)
	Delete Reaction object.
int32_t	rxn_cabinetSize ()
	Return size of Reaction storage.
int32_t	rxn_parentHandle (int32_t handle)
	Return handle to parent of Reaction object.