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

Detailed Description

CTONEDIM - Generated CLib Cantera interface library.

Generated CLib API for Cantera's Sim1D 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/ctonedim.h.

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

Go to the source code of this file.

Functions
int32_t	sim1D_newSim1D (int32_t domainsLen, int32_t *domains)
	Create a Sim1D object with a list of domains.

int32_t	sim1D_setValue (int32_t handle, int32_t dom, int32_t comp, int32_t localPoint, double value)
	Set a single value in the solution vector.

int32_t	sim1D_setProfile (int32_t handle, int32_t dom, int32_t comp, int32_t posLen, const double pos, int32_t valuesLen, const double values)
	Specify a profile for one component of one domain.

int32_t	sim1D_setFlatProfile (int32_t handle, int32_t dom, int32_t comp, double v)
	Set component 'comp' of domain 'dom' to value 'v' at all points.

int32_t	sim1D_setInitialGuess (int32_t handle, const char component, int32_t locsLen, double locs, int32_t valsLen, double *vals)
	Set initial guess for one component for all domains.

int32_t	sim1D_show (int32_t handle)
	Show logging information on current solution for all domains.

int32_t	sim1D_setTimeStep (int32_t handle, double stepsize, int32_t n, int32_t tstepsLen, const int32_t *tsteps)
	Set the number of time steps to try when the steady Newton solver is unsuccessful.

int32_t	sim1D_getInitialSoln (int32_t handle)
	Get the initial value of the system state from each domain in the simulation.

int32_t	sim1D_solve (int32_t handle, int32_t loglevel, int32_t refine_grid)
	Performs the hybrid Newton steady/time-stepping solution.

int32_t	sim1D_refine (int32_t handle, int32_t loglevel)
	Refine the grid in all domains.

int32_t	sim1D_setRefineCriteria (int32_t handle, int32_t dom, double ratio, double slope, double curve, double prune)
	Set grid refinement criteria.

int32_t	sim1D_setGridMin (int32_t handle, int32_t dom, double gridmin)
	Set the minimum grid spacing in the specified domain(s).

int32_t	sim1D_save (int32_t handle, const char fname, const char name, const char *desc)
	Save current simulation data to a container file or CSV format.

int32_t	sim1D_writeStats (int32_t handle, int32_t printTime)
	Write statistics about the number of iterations and Jacobians at each grid level.

int32_t	sim1D_domainIndex (int32_t handle, const char *name)
	Get the index of the domain named.

double	sim1D_value (int32_t handle, int32_t dom, int32_t comp, int32_t localPoint)
	Get one entry in the solution vector.

double	sim1D_workValue (int32_t handle, int32_t dom, int32_t comp, int32_t localPoint)
	Get an entry in the work vector, which may contain either a new system state or the current residual of the system.

int32_t	sim1D_eval (int32_t handle, int32_t xLen, double x, int32_t rLen, double r, double rdt, int32_t count)
	Evaluate the residual function.

int32_t	sim1D_setMaxJacAge (int32_t handle, int32_t ss_age, int32_t ts_age)
	Set the maximum number of steps that can be taken using the same Jacobian before it must be re-evaluated.

int32_t	sim1D_setFixedTemperature (int32_t handle, double t)
	Add node for fixed temperature point of freely propagating flame.

int32_t	sim1D_del (int32_t handle)
	Delete Sim1D object.

int32_t	sim1D_cabinetSize ()
	Return size of Sim1D storage.

int32_t	sim1D_parentHandle (int32_t handle)
	Return handle to parent of Sim1D object.

Detailed Description

Functions