ctrxn Library

Generated CLib API for Cantera's Reaction class. More...

Collaboration diagram for ctrxn Library:

Detailed Description

Generated CLib API for Cantera's Reaction class.

Warning

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

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.

Function Documentation

rxn_new()

int32_t rxn_new

(

)

Instantiate Reaction object using default constructor.

Wraps C++ constructor: undefined

Returns

Object handle if successful and -1 for exception handling.

Definition at line 37 of file ctrxn.cpp.

rxn_equation()

int32_t rxn_equation	(	int32_t	handle,
		int32_t	bufLen,
		char *	buf
	)

The chemical equation for this reaction.

Wraps C++ getter: string Reaction::equation()

Parameters

	handle	Handle to queried Reaction object.
[in]	bufLen	Length of reserved array.
[out]	buf	Returned string value.

Returns

Actual length of string including string-terminating null byte, \0, or -1 for exception handling.

Definition at line 47 of file ctrxn.cpp.

rxn_type()

int32_t rxn_type	(	int32_t	handle,
		int32_t	bufLen,
		char *	buf
	)

The type of reaction, including reaction rate information.

Wraps C++ getter: string Reaction::type()

Parameters

	handle	Handle to queried Reaction object.
[in]	bufLen	Length of reserved array.
[out]	buf	Returned string value.

Returns

Actual length of string including string-terminating null byte, \0, or -1 for exception handling.

Definition at line 59 of file ctrxn.cpp.

rxn_usesThirdBody()

int32_t rxn_usesThirdBody

(

int32_t

handle

)

Check whether reaction involves third body collider.

Wraps C++ getter: bool Reaction::usesThirdBody()

Parameters

handle

Handle to queried Reaction object.

Definition at line 71 of file ctrxn.cpp.

rxn_valid()

int32_t rxn_valid

(

int32_t

handle

)

Get validity flag of reaction.

Wraps C++ getter: bool Reaction::valid()

Parameters

handle

Handle to queried Reaction object.

Definition at line 82 of file ctrxn.cpp.

rxn_id()

int32_t rxn_id	(	int	handle,
		int32_t	bufLen,
		char *	buf
	)

An identification string for the reaction, used in some filtering operations.

Wraps C++ variable-getter: string Reaction::id

Parameters

	handle	Handle to queried Reaction object.
[in]	bufLen	Length of reserved array.
[out]	buf	Returned string value.

Returns

Actual length of string including string-terminating null byte, \0, or -1 for exception handling.

Definition at line 93 of file ctrxn.cpp.

rxn_setId()

int32_t rxn_setId	(	int32_t	handle,
		const char *	id
	)

An identification string for the reaction, used in some filtering operations.

Wraps C++ variable-setter: string Reaction::id

Parameters

	handle	Handle to queried Reaction object.
[in]	id	An identification string for the reaction, used in some filtering operations.

Definition at line 105 of file ctrxn.cpp.

rxn_allowNonreactantOrders()

int32_t rxn_allowNonreactantOrders

(

int

handle

)

True if reaction orders can be specified for non-reactant species.

Wraps C++ variable-getter: bool Reaction::allow_nonreactant_orders

Parameters

handle

Handle to queried Reaction object.

Definition at line 116 of file ctrxn.cpp.

rxn_setAllowNonreactantOrders()

int32_t rxn_setAllowNonreactantOrders	(	int32_t	handle,
		int32_t	allow_nonreactant_orders
	)

True if reaction orders can be specified for non-reactant species.

Wraps C++ variable-setter: bool Reaction::allow_nonreactant_orders

Parameters

	handle	Handle to queried Reaction object.
[in]	allow_nonreactant_orders	True if reaction orders can be specified for non-reactant species.

Definition at line 127 of file ctrxn.cpp.

rxn_del()

int32_t rxn_del

(

int32_t

handle

)

Delete Reaction object.

Wraps C++ destructor: undefined

Parameters

handle

Handle to Reaction object.

Returns

Zero for success and -1 for exception handling.

Definition at line 139 of file ctrxn.cpp.

rxn_cabinetSize()

int32_t rxn_cabinetSize

(

)

Return size of Reaction storage.

Wraps C++ reserved CLib function: custom code

Returns

Size or -1 for exception handling.

Definition at line 150 of file ctrxn.cpp.

rxn_parentHandle()

int32_t rxn_parentHandle

(

int32_t

handle

)

Return handle to parent of Reaction object.

Wraps C++ reserved CLib function: custom code

Parameters

handle

Handle to queried Reaction object.

Returns

Parent handle or -1 for exception handling.

Definition at line 162 of file ctrxn.cpp.