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

Collaboration diagram for ctreactor Library:

Detailed Description

Generated CLib API for Cantera's ReactorBase class.

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

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.

Function Documentation

◆ reactor_new()

int32_t reactor_new	(	const char *	model,
		int32_t	contents,
		const char *	name
	)

Create a ReactorBase object of the specified type and contents.

Wraps C++ constructor: shared_ptr<ReactorBase> newReactorBase(const string&, shared_ptr<Solution>, const string&)

Parameters

model	Undocumented.
contents	Integer handle to Solution object. Undocumented.
name	Undocumented.

Returns: Handle to stored ReactorBase object or -1 for exception handling.

Definition at line 42 of file ctreactor.cpp.

◆ reactor_type()

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

String indicating the reactor model implemented.

Wraps C++ getter: virtual string ReactorBase::type()

Parameters

	handle	Handle to queried ReactorBase 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 52 of file ctreactor.cpp.

◆ reactor_name()

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

Return the name of this reactor.

Wraps C++ getter: string ReactorBase::name()

Parameters

	handle	Handle to queried ReactorBase 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 64 of file ctreactor.cpp.

◆ reactor_setName()

int32_t reactor_setName	(	int32_t	handle,
		const char *	name
	)

Set the name of this reactor.

Wraps C++ setter: void ReactorBase::setName(const string&)

Parameters

handle	Handle to queried ReactorBase object.
name	Undocumented.

Definition at line 76 of file ctreactor.cpp.

◆ reactor_setInitialVolume()

int32_t reactor_setInitialVolume	(	int32_t	handle,
		double	vol
	)

Set the initial reactor volume.

Wraps C++ setter: virtual void ReactorBase::setInitialVolume(double)

Parameters

handle	Handle to queried ReactorBase object.
vol	Undocumented.

Definition at line 87 of file ctreactor.cpp.

◆ reactor_setChemistry()

int32_t reactor_setChemistry	(	int32_t	handle,
		int32_t	cflag
	)

Enable or disable changes in reactor composition due to chemical reactions.

Wraps C++ setter: virtual void ReactorBase::setChemistry(bool)

Parameters

handle	Handle to queried ReactorBase object.
cflag	Undocumented.

Definition at line 98 of file ctreactor.cpp.

◆ reactor_setEnergy()

int32_t reactor_setEnergy	(	int32_t	handle,
		int32_t	eflag
	)

Set the energy equation on or off.

Wraps C++ setter: virtual void ReactorBase::setEnergy(int)

Parameters

handle	Handle to queried ReactorBase object.
eflag	Undocumented.

Definition at line 110 of file ctreactor.cpp.

◆ reactor_mass()

double reactor_mass ( int32_t handle )

Returns the mass (kg) of the reactor's contents.

Wraps C++ getter: double ReactorBase::mass()

Parameters

handle Handle to queried ReactorBase object.

Definition at line 121 of file ctreactor.cpp.

◆ reactor_volume()

double reactor_volume ( int32_t handle )

Returns the current volume (m^3) of the reactor.

Wraps C++ getter: double ReactorBase::volume()

Parameters

handle Handle to queried ReactorBase object.

Definition at line 131 of file ctreactor.cpp.

◆ reactor_density()

double reactor_density ( int32_t handle )

Returns the current density (kg/m^3) of the reactor's contents.

Wraps C++ getter: double ReactorBase::density()

Parameters

handle Handle to queried ReactorBase object.

Definition at line 141 of file ctreactor.cpp.

◆ reactor_temperature()

double reactor_temperature ( int32_t handle )

Returns the current temperature (K) of the reactor's contents.

Wraps C++ getter: double ReactorBase::temperature()

Parameters

handle Handle to queried ReactorBase object.

Definition at line 151 of file ctreactor.cpp.

◆ reactor_enthalpy_mass()

double reactor_enthalpy_mass ( int32_t handle )

Returns the current enthalpy (J/kg) of the reactor's contents.

Wraps C++ getter: double ReactorBase::enthalpy_mass()

Parameters

handle Handle to queried ReactorBase object.

Definition at line 161 of file ctreactor.cpp.

◆ reactor_intEnergy_mass()

double reactor_intEnergy_mass ( int32_t handle )

Returns the current internal energy (J/kg) of the reactor's contents.

Wraps C++ getter: double ReactorBase::intEnergy_mass()

Parameters

handle Handle to queried ReactorBase object.

Definition at line 171 of file ctreactor.cpp.

◆ reactor_pressure()

double reactor_pressure ( int32_t handle )

Returns the current pressure (Pa) of the reactor.

Wraps C++ getter: double ReactorBase::pressure()

Parameters

handle Handle to queried ReactorBase object.

Definition at line 181 of file ctreactor.cpp.

◆ reactor_massFraction()

double reactor_massFraction	(	int32_t	handle,
		int32_t	k
	)

Return the mass fraction of the.

Wraps C++ method: double ReactorBase::massFraction(size_t)

Parameters

handle	Handle to queried ReactorBase object.
k	Undocumented.

Definition at line 191 of file ctreactor.cpp.

◆ reactor_nSensParams()

int32_t reactor_nSensParams ( int32_t handle )

Number of sensitivity parameters associated with this reactor.

Wraps C++ getter: virtual size_t ReactorBase::nSensParams()

Parameters

handle Handle to queried ReactorBase object.

Definition at line 201 of file ctreactor.cpp.

◆ reactor_addSensitivityReaction()

int32_t reactor_addSensitivityReaction	(	int32_t	handle,
		int32_t	rxn
	)

Add a sensitivity parameter associated with the reaction number.

Wraps C++ setter: virtual void ReactorBase::addSensitivityReaction(size_t)

Parameters

handle	Handle to queried ReactorBase object.
rxn	Undocumented.

Definition at line 211 of file ctreactor.cpp.

◆ reactor_addSurface()

int32_t reactor_addSurface	(	int32_t	handle,
		int32_t	surf
	)

Add a ReactorSurface object to a Reactor object.

Wraps C++ setter: void ReactorBase::addSurface(shared_ptr<ReactorBase>)

Parameters

handle	Handle to queried ReactorBase object.
surf	Integer handle to ReactorBase object. Undocumented.

Definition at line 222 of file ctreactor.cpp.

◆ reactor_setMassFlowRate()

int32_t reactor_setMassFlowRate	(	int32_t	handle,
		double	mdot
	)

Set the mass flow rate through the reactor [kg/s].

Wraps C++ setter: void FlowReactor::setMassFlowRate(double)

Parameters

handle	Handle to queried FlowReactor object.
mdot	Undocumented.

Definition at line 233 of file ctreactor.cpp.

◆ reactor_area()

double reactor_area ( int32_t handle )

The cross-sectional area of the reactor [m^2].

Wraps C++ getter: double FlowReactor::area()

Parameters

handle Handle to queried FlowReactor object.

Definition at line 244 of file ctreactor.cpp.

◆ reactor_setArea()

int32_t reactor_setArea	(	int32_t	handle,
		double	area
	)

Sets the area of the reactor [m^2].

Wraps C++ setter: void FlowReactor::setArea(double)

Parameters

handle	Handle to queried FlowReactor object.
area	Undocumented.

Definition at line 254 of file ctreactor.cpp.

◆ reactor_del()

int32_t reactor_del ( int32_t handle )

Delete ReactorBase object.

Wraps C++ destructor: undefined

Parameters

handle Handle to ReactorBase object.

Returns: Zero for success and -1 for exception handling.

Definition at line 265 of file ctreactor.cpp.

◆ reactor_cabinetSize()

int32_t reactor_cabinetSize ( )

Return size of ReactorBase storage.

Wraps C++ reserved CLib function: custom code

Returns: Size or -1 for exception handling.

Definition at line 276 of file ctreactor.cpp.

◆ reactor_parentHandle()

int32_t reactor_parentHandle ( int32_t handle )

Return handle to parent of ReactorBase object.

Wraps C++ reserved CLib function: custom code

Parameters

handle Handle to queried ReactorBase object.

Returns: Parent handle or -1 for exception handling.

Definition at line 288 of file ctreactor.cpp.

Detailed Description

Functions

Function Documentation

◆ reactor_new()

◆ reactor_type()

◆ reactor_name()

◆ reactor_setName()

◆ reactor_setInitialVolume()

◆ reactor_setChemistry()

◆ reactor_setEnergy()

◆ reactor_mass()

◆ reactor_volume()

◆ reactor_density()

◆ reactor_temperature()

◆ reactor_enthalpy_mass()

◆ reactor_intEnergy_mass()

◆ reactor_pressure()

◆ reactor_massFraction()

◆ reactor_nSensParams()

◆ reactor_addSensitivityReaction()

◆ reactor_addSurface()

◆ reactor_setMassFlowRate()

◆ reactor_area()

◆ reactor_setArea()

◆ reactor_del()

◆ reactor_cabinetSize()

◆ reactor_parentHandle()