ctdomain.h

Go to the documentation of this file.

/**
 *  CTDOMAIN - Generated CLib %Cantera interface library.
 *
 *  @file ctdomain.h
 *
 *  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.
 */
 
// This file is part of Cantera. See License.txt in the top-level directory or
// at https://cantera.org/license.txt for license and copyright information.
 
#ifndef CTDOMAIN_H
#define CTDOMAIN_H
 
#include <stdint.h>  // for 32-bit int32_t / 64-bit int64_t
 
#ifdef __cplusplus
extern "C" {
#endif
 
    /**
     *  @defgroup CAPIctdomain ctdomain Library
     *  Generated CLib API for %Cantera's Domain1D class.
     *
     *  @warning  This library is an experimental part of the %Cantera API and
     *      may be changed or removed without notice.
     *
     *  @ingroup CAPIindex
     */
 
    /**
     *  @addtogroup CAPIctdomain
     *  @{
     */
 
    /**
     *  Create a Flow1D object of the specified type.
     *
     *  Wraps C++ constructor: `shared_ptr<Flow1D> newFlow1D(const string&, shared_ptr<Solution>, const string&)`
     *
     *  @param domainType   string identifying domain type.
     *  @param solution     Integer handle to Solution object. Solution holding ThermoPhase, Kinetics and Transport objects.
     *  @param id           string identifier describing domain. If omitted, id defaults to the domain type identifier.
     *  @returns            Handle to stored Flow1D object or -1 for exception handling.
     */
    int32_t domain_newFlow1D(const char* domainType, int32_t solution, const char* id);
 
    /**
     *  Create a Boundary1D object of the specified type.
     *
     *  Wraps C++ constructor: `shared_ptr<Boundary1D> newBoundary1D(const string&, shared_ptr<Solution>, const string&)`
     *
     *  @param domainType   string identifying domain type.
     *  @param solution     Integer handle to Solution object. Solution holding ThermoPhase, Kinetics and Transport objects.
     *  @param id           string identifier describing domain. If omitted, id defaults to the domain type identifier.
     *  @returns            Handle to stored Boundary1D object or -1 for exception handling.
     */
    int32_t domain_newBoundary1D(const char* domainType, int32_t solution, const char* id);
 
    /**
     *  String indicating the domain implemented.
     *
     *  Wraps C++ getter: `string Domain1D::type()`
     *
     *  @param handle       Handle to queried Domain1D object.
     *  @param[in] bufLen   Length of reserved array.
     *  @param[out] buf     Returned string value.
     *  @returns            Actual length of string including string-terminating null byte, \0, or -1 for exception handling.
     *
     *  @deprecated Per C++ annotation: Transitional method. Use domainType() instead.
     */
    int32_t domain_type(int32_t handle, int32_t bufLen, char* buf);
 
    /**
     *  The left-to-right location of this domain.
     *
     *  Wraps C++ getter: `size_t Domain1D::domainIndex()`
     *
     *  @param handle       Handle to queried Domain1D object.
     */
    int32_t domain_domainIndex(int32_t handle);
 
    /**
     *  Returns the index of the solution vector, which corresponds to component n at grid point j.
     *
     *  Wraps C++ method: `size_t Domain1D::index(size_t, size_t)`
     *
     *  @param handle       Handle to queried Domain1D object.
     *  @param n            component index
     *  @param j            grid point index
     */
    int32_t domain_index(int32_t handle, int32_t n, int32_t j);
 
    /**
     *  Number of components at each grid point.
     *
     *  Wraps C++ getter: `size_t Domain1D::nComponents()`
     *
     *  @param handle       Handle to queried Domain1D object.
     */
    int32_t domain_nComponents(int32_t handle);
 
    /**
     *  Number of grid points in this domain.
     *
     *  Wraps C++ getter: `size_t Domain1D::nPoints()`
     *
     *  @param handle       Handle to queried Domain1D object.
     */
    int32_t domain_nPoints(int32_t handle);
 
    /**
     *  Name of component `n`. May be overloaded.
     *
     *  Wraps C++ method: `virtual string Domain1D::componentName(size_t)`
     *
     *  @param handle       Handle to queried Domain1D object.
     *  @param n            Undocumented.
     *  @param[in] bufLen   Length of reserved array.
     *  @param[out] buf     Returned string value.
     *  @returns            Actual length of string including string-terminating null byte, \0, or -1 for exception handling.
     */
    int32_t domain_componentName(int32_t handle, int32_t n, int32_t bufLen, char* buf);
 
    /**
     *  Index of component with name `name`.
     *
     *  Wraps C++ method: `virtual size_t Domain1D::componentIndex(const string&)`
     *
     *  @param handle       Handle to queried Domain1D object.
     *  @param name         name of component
     */
    int32_t domain_componentIndex(int32_t handle, const char* name);
 
    /**
     *  Set a single component value at a boundary.
     *
     *  Wraps C++ method: `virtual double Domain1D::value(const string&)`
     *
     *  @param handle       Handle to queried Domain1D object.
     *  @param component    Name of the component.
     */
    double domain_value(int32_t handle, const char* component);
 
    /**
     *  Set a single component value in a flow domain or at a boundary.
     *
     *  Wraps C++ method: `virtual void Domain1D::setValue(const string&, double)`
     *
     *  @param handle       Handle to queried Domain1D object.
     *  @param component    Name of the component.
     *  @param value        Value of the component.
     */
    int32_t domain_setValue(int32_t handle, const char* component, double value);
 
    /**
     *  Retrieve component values.
     *
     *  Wraps C++ method: `vector<double> Domain1D::values(const string&)`
     *
     *  @param handle       Handle to queried Domain1D object.
     *  @param component    Name of the component.
     *  @param[in] bufLen   Length of reserved array.
     *  @param[out] buf     Returned array value.
     *  @returns            Actual length of value array or -1 for exception handling.
     */
    int32_t domain_values(int32_t handle, const char* component, int32_t bufLen, double* buf);
 
    /**
     *  Retrieve component values.
     *
     *  Wraps C++ method: `virtual void Domain1D::getValues(const string&, vector<double>&)`
     *
     *  @param handle       Handle to queried Domain1D object.
     *  @param component    Name of the component.
     *  @param[in] valuesLen Length of vector reserved for values.
     *  @param[out] values  Vector of length nPoints() containing values at grid points.
     */
    int32_t domain_getValues(int32_t handle, const char* component, int32_t valuesLen, double* values);
 
    /**
     *  Specify component values.
     *
     *  Wraps C++ method: `virtual void Domain1D::setValues(const string&, const vector<double>&)`
     *
     *  @param handle       Handle to queried Domain1D object.
     *  @param component    Name of the component.
     *  @param[in] valuesLen Length of vector reserved for values.
     *  @param[in] values   Vector of length nPoints() containing values at grid points.
     */
    int32_t domain_setValues(int32_t handle, const char* component, int32_t valuesLen, const double* values);
 
    /**
     *  Retrieve internal work array values for a component.
     *
     *  Wraps C++ method: `vector<double> Domain1D::residuals(const string&)`
     *
     *  @param handle       Handle to queried Domain1D object.
     *  @param component    Name of the component.
     *  @param[in] bufLen   Length of reserved array.
     *  @param[out] buf     Returned array value.
     *  @returns            Actual length of value array or -1 for exception handling.
     */
    int32_t domain_residuals(int32_t handle, const char* component, int32_t bufLen, double* buf);
 
    /**
     *  Specify a profile for a component.
     *
     *  Wraps C++ method: `virtual void Domain1D::setProfile(const string&, const vector<double>&, const vector<double>&)`
     *
     *  @param handle       Handle to queried Domain1D object.
     *  @param component    Undocumented.
     *  @param[in] posLen   Length of vector reserved for pos.
     *  @param pos          Undocumented.
     *  @param[in] valuesLen Length of vector reserved for values.
     *  @param values       Undocumented.
     */
    int32_t domain_setProfile(int32_t handle, const char* component, int32_t posLen, const double* pos, int32_t valuesLen, const double* values);
 
    /**
     *  Specify a flat profile for a component.
     *
     *  Wraps C++ method: `virtual void Domain1D::setFlatProfile(const string&, double)`
     *
     *  @param handle       Handle to queried Domain1D object.
     *  @param component    Name of the component.
     *  @param value        Constant value.
     */
    int32_t domain_setFlatProfile(int32_t handle, const char* component, double value);
 
    /**
     *  Set the upper and lower bounds for a solution component, n.
     *
     *  Wraps C++ method: `void Domain1D::setBounds(size_t, double, double)`
     *
     *  @param handle       Handle to queried Domain1D object.
     *  @param n            solution component index
     *  @param lower        lower bound on component n
     *  @param upper        upper bound on component n
     */
    int32_t domain_setBounds(int32_t handle, int32_t n, double lower, double upper);
 
    /**
     *  Lower bound on the nth component.
     *
     *  Wraps C++ method: `double Domain1D::lowerBound(size_t)`
     *
     *  @param handle       Handle to queried Domain1D object.
     *  @param n            Undocumented.
     */
    double domain_lowerBound(int32_t handle, int32_t n);
 
    /**
     *  Upper bound on the nth component.
     *
     *  Wraps C++ method: `double Domain1D::upperBound(size_t)`
     *
     *  @param handle       Handle to queried Domain1D object.
     *  @param n            Undocumented.
     */
    double domain_upperBound(int32_t handle, int32_t n);
 
    /**
     *  Set tolerances for steady-state mode.
     *
     *  Wraps C++ method: `void Domain1D::setSteadyTolerances(double, double, size_t)`
     *
     *  @param handle       Handle to queried Domain1D object.
     *  @param rtol         Relative tolerance
     *  @param atol         Absolute tolerance
     *  @param n            component index these tolerances apply to. If set to -1 (the default), these tolerances will be applied to all solution components.
     */
    int32_t domain_setSteadyTolerances(int32_t handle, double rtol, double atol, int32_t n);
 
    /**
     *  Set tolerances for time-stepping mode.
     *
     *  Wraps C++ method: `void Domain1D::setTransientTolerances(double, double, size_t)`
     *
     *  @param handle       Handle to queried Domain1D object.
     *  @param rtol         Relative tolerance
     *  @param atol         Absolute tolerance
     *  @param n            component index these tolerances apply to. If set to -1 (the default), these tolerances will be applied to all solution components.
     */
    int32_t domain_setTransientTolerances(int32_t handle, double rtol, double atol, int32_t n);
 
    /**
     *  Relative tolerance of the nth component.
     *
     *  Wraps C++ method: `double Domain1D::rtol(size_t)`
     *
     *  @param handle       Handle to queried Domain1D object.
     *  @param n            Undocumented.
     */
    double domain_rtol(int32_t handle, int32_t n);
 
    /**
     *  Absolute tolerance of the nth component.
     *
     *  Wraps C++ method: `double Domain1D::atol(size_t)`
     *
     *  @param handle       Handle to queried Domain1D object.
     *  @param n            Undocumented.
     */
    double domain_atol(int32_t handle, int32_t n);
 
    /**
     *  Set up initial grid.
     *
     *  Wraps C++ setter: `void Domain1D::setupGrid(const vector<double>&)`
     *
     *  @param handle       Handle to queried Domain1D object.
     *  @param[in] gridLen  Length of vector reserved for grid.
     *  @param grid         Undocumented.
     */
    int32_t domain_setupGrid(int32_t handle, int32_t gridLen, const double* grid);
 
    /**
     *  Set up uniform grid.
     *
     *  Wraps C++ method: `void Domain1D::setupUniformGrid(size_t, double, double)`
     *
     *  @param handle       Handle to queried Domain1D object.
     *  @param points       Number of grid points
     *  @param length       Length of domain
     *  @param start        Start position of domain (default=0.)
     */
    int32_t domain_setupUniformGrid(int32_t handle, int32_t points, double length, double start);
 
    /**
     *  Specify an identifying tag for this domain.
     *
     *  Wraps C++ setter: `void Domain1D::setID(const string&)`
     *
     *  @param handle       Handle to queried Domain1D object.
     *  @param s            Undocumented.
     */
    int32_t domain_setID(int32_t handle, const char* s);
 
    /**
     *  Access the array of grid coordinates [m].
     *
     *  Wraps C++ getter: `vector<double>& Domain1D::grid()`
     *
     *  @param handle       Handle to queried Domain1D object.
     *  @param[in] bufLen   Length of reserved array.
     *  @param[out] buf     Returned array value.
     *  @returns            Actual length of value array or -1 for exception handling.
     */
    int32_t domain_grid(int32_t handle, int32_t bufLen, double* buf);
 
    /**
     *  Set the total mass flow rate [kg/m²/s].
     *
     *  Wraps C++ setter: `virtual void Boundary1D::setMdot(double)`
     *
     *  @param handle       Handle to queried Boundary1D object.
     *  @param mdot         Undocumented.
     */
    int32_t bdry_setMdot(int32_t handle, double mdot);
 
    /**
     *  Set the temperature.
     *
     *  Wraps C++ setter: `virtual void Boundary1D::setTemperature(double)`
     *
     *  @param handle       Handle to queried Boundary1D object.
     *  @param t            Undocumented.
     */
    int32_t bdry_setTemperature(int32_t handle, double t);
 
    /**
     *  Set tangential velocity gradient [1/s] at this boundary.
     *
     *  Wraps C++ setter: `virtual void Boundary1D::setSpreadRate(double)`
     *
     *  @param handle       Handle to queried Boundary1D object.
     *  @param V0           Undocumented.
     */
    int32_t bdry_setSpreadRate(int32_t handle, double V0);
 
    /**
     *  Set the mole fractions by specifying a string.
     *
     *  Wraps C++ setter: `virtual void Boundary1D::setMoleFractions(const string&)`
     *
     *  @param handle       Handle to queried Boundary1D object.
     *  @param xin          Undocumented.
     */
    int32_t bdry_setMoleFractionsByName(int32_t handle, const char* xin);
 
    /**
     *  Set the mole fractions by specifying an array.
     *
     *  Wraps C++ setter: `virtual void Boundary1D::setMoleFractions(const double*)`
     *
     *  @param handle       Handle to queried Boundary1D object.
     *  @param[in] xinLen   Length of array reserved for xin.
     *  @param xin          Undocumented.
     */
    int32_t bdry_setMoleFractions(int32_t handle, int32_t xinLen, const double* xin);
 
    /**
     *  The total mass flow rate [kg/m2/s].
     *
     *  Wraps C++ getter: `virtual double Boundary1D::mdot()`
     *
     *  @param handle       Handle to queried Boundary1D object.
     */
    double bdry_mdot(int32_t handle);
 
    /**
     *  Temperature [K].
     *
     *  Wraps C++ getter: `virtual double Boundary1D::temperature()`
     *
     *  @param handle       Handle to queried Boundary1D object.
     */
    double bdry_temperature(int32_t handle);
 
    /**
     *  Tangential velocity gradient [1/s] at this boundary.
     *
     *  Wraps C++ getter: `virtual double Boundary1D::spreadRate()`
     *
     *  @param handle       Handle to queried Boundary1D object.
     */
    double bdry_spreadRate(int32_t handle);
 
    /**
     *  Mass fraction of species k.
     *
     *  Wraps C++ method: `virtual double Boundary1D::massFraction(size_t)`
     *
     *  @param handle       Handle to queried Boundary1D object.
     *  @param k            Undocumented.
     */
    double bdry_massFraction(int32_t handle, int32_t k);
 
    /**
     *  Set transport model to existing instance.
     *
     *  Wraps C++ setter: `virtual void Domain1D::setTransport(shared_ptr<Transport>)`
     *
     *  @param handle       Handle to queried Domain1D object.
     *  @param trans        Integer handle to Transport object. Undocumented.
     */
    int32_t domain_setTransport(int32_t handle, int32_t trans);
 
    /**
     *  Retrieve transport model.
     *
     *  Wraps C++ getter: `string Flow1D::transportModel()`
     *
     *  @param handle       Handle to queried Flow1D object.
     *  @param[in] bufLen   Length of reserved array.
     *  @param[out] buf     Returned string value.
     *  @returns            Actual length of string including string-terminating null byte, \0, or -1 for exception handling.
     */
    int32_t flow_transportModel(int32_t handle, int32_t bufLen, char* buf);
 
    /**
     *  Set transport model by name.
     *
     *  Wraps C++ setter: `virtual void Domain1D::setTransportModel(const string&)`
     *
     *  @param handle       Handle to queried Domain1D object.
     *  @param model        String specifying model name.
     */
    int32_t domain_setTransportModel(int32_t handle, const char* model);
 
    /**
     *  Enable thermal diffusion, also known as Soret diffusion.
     *
     *  Wraps C++ setter: `void Flow1D::enableSoret(bool)`
     *
     *  @param handle       Handle to queried Flow1D object.
     *  @param withSoret    Undocumented.
     */
    int32_t flow_enableSoret(int32_t handle, int32_t withSoret);
 
    /**
     *  Set the pressure.
     *
     *  Wraps C++ setter: `void Flow1D::setPressure(double)`
     *
     *  @param handle       Handle to queried Flow1D object.
     *  @param p            Undocumented.
     */
    int32_t flow_setPressure(int32_t handle, double p);
 
    /**
     *  The current pressure [Pa].
     *
     *  Wraps C++ getter: `double Flow1D::pressure()`
     *
     *  @param handle       Handle to queried Flow1D object.
     */
    double flow_pressure(int32_t handle);
 
    /**
     *  Set fixed temperature profile.
     *
     *  Wraps C++ method: `void Flow1D::setFixedTempProfile(const vector<double>&, const vector<double>&)`
     *
     *  @param handle       Handle to queried Flow1D object.
     *  @param[in] zfixedLen Length of vector reserved for zfixed.
     *  @param zfixed       Vector containing locations where profile is specified.
     *  @param[in] tfixedLen Length of vector reserved for tfixed.
     *  @param tfixed       Vector containing specified temperatures.
     */
    int32_t flow_setFixedTempProfile(int32_t handle, int32_t zfixedLen, const double* zfixed, int32_t tfixedLen, const double* tfixed);
 
    /**
     *  Specify that the energy equation should be solved at point `j`.
     *
     *  Wraps C++ setter: `void Flow1D::solveEnergyEqn(size_t)`
     *
     *  @param handle       Handle to queried Flow1D object.
     *  @param j            Point at which to enable the energy equation. `npos` means all points.
     */
    int32_t flow_solveEnergyEqn(int32_t handle, int32_t j);
 
    /**
     *  Check if energy is enabled for entire domain.
     *
     *  Wraps C++ getter: `bool Flow1D::allOfEnergyEnabled()`
     *
     *  @param handle       Handle to queried Flow1D object.
     */
    int32_t flow_allOfEnergyEnabled(int32_t handle);
 
    /**
     *  Check if energy is disabled for entire domain.
     *
     *  Wraps C++ getter: `bool Flow1D::noneOfEnergyEnabled()`
     *
     *  @param handle       Handle to queried Flow1D object.
     */
    int32_t flow_noneOfEnergyEnabled(int32_t handle);
 
    /**
     *  Set energy enabled flag for entire domain.
     *
     *  Wraps C++ setter: `void Flow1D::setEnergyEnabled(bool)`
     *
     *  @param handle       Handle to queried Flow1D object.
     *  @param flag         Undocumented.
     */
    int32_t flow_setEnergyEnabled(int32_t handle, int32_t flag);
 
    /**
     *  Set whether to solve the equations for the surface species coverages.
     *
     *  Wraps C++ setter: `void ReactingSurf1D::enableCoverageEquations(bool)`
     *
     *  @param handle       Handle to queried ReactingSurf1D object.
     *  @param docov        Undocumented.
     */
    int32_t reactingsurf_enableCoverageEquations(int32_t handle, int32_t docov);
 
    /**
     *  Get the grid refinement criteria.
     *
     *  Wraps C++ getter: `vector<double> Domain1D::getRefineCriteria()`
     *
     *  @param handle       Handle to queried Domain1D object.
     *  @param[in] bufLen   Length of reserved array.
     *  @param[out] buf     Returned array value.
     *  @returns            Actual length of value array or -1 for exception handling.
     */
    int32_t domain_getRefineCriteria(int32_t handle, int32_t bufLen, double* buf);
 
    /**
     *  Set grid refinement criteria.
     *
     *  Wraps C++ method: `void Domain1D::setRefineCriteria(double, double, double, double)`
     *
     *  @param handle       Handle to queried Domain1D object.
     *  @param ratio        Undocumented.
     *  @param slope        Undocumented.
     *  @param curve        Undocumented.
     *  @param prune        Undocumented.
     */
    int32_t domain_setRefineCriteria(int32_t handle, double ratio, double slope, double curve, double prune);
 
    /**
     *  Return a concise summary of a Domain.
     *
     *  Wraps C++ method: `string Domain1D::_info(int, int)`
     *
     *  @param handle       Handle to queried Domain1D object.
     *  @param rows         Maximum number of rendered rows.
     *  @param width        Maximum width of rendered output.
     *  @param[in] bufLen   Length of reserved array.
     *  @param[out] buf     Returned string value.
     *  @returns            Actual length of string including string-terminating null byte, \0, or -1 for exception handling.
     */
    int32_t domain_info(int32_t handle, int32_t rows, int32_t width, int32_t bufLen, char* buf);
 
    /**
     *  Delete Domain1D object.
     *
     *  Wraps C++ destructor: `undefined`
     *
     *  @param handle       Handle to Domain1D object.
     *  @returns            Zero for success and -1 for exception handling.
     */
    int32_t domain_del(int32_t handle);
 
    /**
     *  Return size of Domain1D storage.
     *
     *  Wraps C++ reserved CLib function: `custom code`
     *
     *  @returns            Size or -1 for exception handling.
     */
    int32_t domain_cabinetSize();
 
    /**
     *  @}
     */
 
#ifdef __cplusplus
}
#endif
 
#endif // CTDOMAIN_H