ctdomain.h File Reference

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

Detailed Description

CTDOMAIN - Generated CLib Cantera interface library.

Generated CLib API for Cantera's Domain1D 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 ctdomain.h.

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

Go to the source code of this file.

Functions
int32_t	domain_newFlow1D (const char *domainType, int32_t solution, const char *id)
	Create a Flow1D object of the specified type.
int32_t	domain_newBoundary1D (const char *domainType, int32_t solution, const char *id)
	Create a Boundary1D object of the specified type.
int32_t	domain_type (int32_t handle, int32_t bufLen, char *buf)
	String indicating the domain implemented.
int32_t	domain_index (int32_t handle, int32_t n, int32_t j)
	Returns the index of the solution vector, which corresponds to component n at grid point j.
int32_t	domain_nComponents (int32_t handle)
	Number of components at each grid point.
int32_t	domain_nPoints (int32_t handle)
	Number of grid points in this domain.
int32_t	domain_componentName (int32_t handle, int32_t n, int32_t bufLen, char *buf)
	Name of component.
int32_t	domain_componentIndex (int32_t handle, const char *name)
	index of component with name
int32_t	domain_setBounds (int32_t handle, int32_t n, double lower, double upper)
	Set the upper and lower bounds for a solution component, n.
double	domain_lowerBound (int32_t handle, int32_t n)
	Lower bound on the nth component.
double	domain_upperBound (int32_t handle, int32_t n)
	Upper bound on the nth component.
int32_t	domain_setSteadyTolerances (int32_t handle, double rtol, double atol, int32_t n)
	Set tolerances for steady-state mode.
int32_t	domain_setTransientTolerances (int32_t handle, double rtol, double atol, int32_t n)
	Set tolerances for time-stepping mode.
double	domain_rtol (int32_t handle, int32_t n)
	Relative tolerance of the nth component.
double	domain_atol (int32_t handle, int32_t n)
	Absolute tolerance of the nth component.
int32_t	domain_setupGrid (int32_t handle, int32_t gridLen, const double *grid)
	Set up initial grid.
int32_t	domain_setupUniformGrid (int32_t handle, int32_t points, double length, double start)
	Set up uniform grid.
int32_t	domain_setID (int32_t handle, const char *s)
	Specify an identifying tag for this domain.
int32_t	domain_grid (int32_t handle, int32_t bufLen, double *buf)
	Access the array of grid coordinates [m].
int32_t	bdry_setMdot (int32_t handle, double mdot)
	Set the total mass flow rate [kg/m²/s].
int32_t	bdry_setTemperature (int32_t handle, double t)
	Set the temperature.
int32_t	bdry_setSpreadRate (int32_t handle, double V0)
	Set tangential velocity gradient [1/s] at this boundary.
int32_t	bdry_setMoleFractions (int32_t handle, const char *xin)
	Set the mole fractions by specifying a string.
double	bdry_mdot (int32_t handle)
	The total mass flow rate [kg/m2/s].
double	bdry_temperature (int32_t handle)
	Temperature [K].
double	bdry_spreadRate (int32_t handle)
	Tangential velocity gradient [1/s] at this boundary.
double	bdry_massFraction (int32_t handle, int32_t k)
	Mass fraction of species k.
int32_t	domain_setTransport (int32_t handle, int32_t trans)
	Set transport model to existing instance.
int32_t	flow_enableSoret (int32_t handle, int32_t withSoret)
	Enable thermal diffusion, also known as Soret diffusion.
int32_t	flow_setPressure (int32_t handle, double p)
	Set the pressure.
double	flow_pressure (int32_t handle)
	The current pressure [Pa].
int32_t	flow_setFixedTempProfile (int32_t handle, int32_t zfixedLen, double *zfixed, int32_t tfixedLen, double *tfixed)
	Sometimes it is desired to carry out the simulation using a specified temperature profile, rather than computing it by solving the energy equation.
int32_t	flow_solveEnergyEqn (int32_t handle, int32_t j)
	Specify that the energy equation should be solved at point.
int32_t	reactingsurf_enableCoverageEquations (int32_t handle, int32_t docov)
	Set whether to solve the equations for the surface species coverages.
int32_t	domain_del (int32_t handle)
	Delete Domain1D object.
int32_t	domain_cabinetSize ()
	Return size of Domain1D storage.
int32_t	domain_parentHandle (int32_t handle)
	Return handle to parent of Domain1D object.