interfaces/clib/include/cantera_clib/ctreactor.h File Reference

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

Detailed Description

CTREACTOR - Generated CLib Cantera interface library.

Generated CLib API for Cantera's ReactorBase 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 interfaces/clib/include/cantera_clib/ctreactor.h.

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

Go to the source code of this file.

Functions
int32_t	reactor_new (const char *model, int32_t contents, const char *name)
	Create a ReactorBase object of the specified type and contents.
int32_t	reactor_type (int32_t handle, int32_t bufLen, char *buf)
	String indicating the reactor model implemented.
int32_t	reactor_name (int32_t handle, int32_t bufLen, char *buf)
	Return the name of this reactor.
int32_t	reactor_setName (int32_t handle, const char *name)
	Set the name of this reactor.
int32_t	reactor_setInitialVolume (int32_t handle, double vol)
	Set the initial reactor volume.
int32_t	reactor_setChemistry (int32_t handle, int32_t cflag)
	Enable or disable changes in reactor composition due to chemical reactions.
int32_t	reactor_setEnergy (int32_t handle, int32_t eflag)
	Set the energy equation on or off.
double	reactor_mass (int32_t handle)
	Returns the mass (kg) of the reactor's contents.
double	reactor_volume (int32_t handle)
	Returns the current volume (m^3) of the reactor.
double	reactor_density (int32_t handle)
	Returns the current density (kg/m^3) of the reactor's contents.
double	reactor_temperature (int32_t handle)
	Returns the current temperature (K) of the reactor's contents.
double	reactor_enthalpy_mass (int32_t handle)
	Returns the current enthalpy (J/kg) of the reactor's contents.
double	reactor_intEnergy_mass (int32_t handle)
	Returns the current internal energy (J/kg) of the reactor's contents.
double	reactor_pressure (int32_t handle)
	Returns the current pressure (Pa) of the reactor.
double	reactor_massFraction (int32_t handle, int32_t k)
	Return the mass fraction of the.
int32_t	reactor_nSensParams (int32_t handle)
	Number of sensitivity parameters associated with this reactor.
int32_t	reactor_addSensitivityReaction (int32_t handle, int32_t rxn)
	Add a sensitivity parameter associated with the reaction number.
int32_t	reactor_addSurface (int32_t handle, int32_t surf)
	Add a ReactorSurface object to a Reactor object.
int32_t	reactor_setMassFlowRate (int32_t handle, double mdot)
	Set the mass flow rate through the reactor [kg/s].
double	reactor_area (int32_t handle)
	The cross-sectional area of the reactor [m^2].
int32_t	reactor_setArea (int32_t handle, double area)
	Sets the area of the reactor [m^2].
int32_t	reactor_del (int32_t handle)
	Delete ReactorBase object.
int32_t	reactor_cabinetSize ()
	Return size of ReactorBase storage.
int32_t	reactor_parentHandle (int32_t handle)
	Return handle to parent of ReactorBase object.