ctsol.h

Go to the documentation of this file.

/**
 *  CTSOL - Generated CLib %Cantera interface library.
 *
 *  @file ctsol.h
 *
 *  Generated CLib API for %Cantera's Solution 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 CTSOL_H
#define CTSOL_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
    /**
     *  @defgroup CAPIctsol ctsol Library
     *  Generated CLib API for %Cantera's Solution class.
     *
     *  @warning  This library is an experimental part of the %Cantera API and
     *      may be changed or removed without notice.
     *
     *  @ingroup CAPIindex
     */
 
    /**
     *  @addtogroup CAPIctsol
     *  @{
     */
 
    /**
     *  Create and initialize a new Solution manager from an input file.
     *
     *  Wraps C++ constructor: `shared_ptr<Solution> newSolution(const string&, const string&, const string&)`
     *
     *  Uses:
     *  - `shared_ptr<ThermoPhase> Solution::thermo()`
     *  - `shared_ptr<Kinetics> Solution::kinetics()`
     *  - `shared_ptr<Transport> Solution::transport()`
     *
     *  @param infile       name of the input file
     *  @param name         name of the phase in the file. If this is blank, the first phase in the file is used.
     *  @param transport    name of the transport model.
     *  @returns            Handle to stored Solution object or -1 for exception handling.
     */
    int32_t sol_newSolution(const char* infile, const char* name, const char* transport);
 
    /**
     *  Create and initialize a new Interface from an input file.
     *
     *  Wraps C++ constructor: `shared_ptr<Interface> newInterface(const string&, const string&, const vector<shared_ptr<Solution>>&)`
     *
     *  Uses:
     *  - `shared_ptr<ThermoPhase> Solution::thermo()`
     *  - `shared_ptr<Kinetics> Solution::kinetics()`
     *
     *  @param infile       name of the input file
     *  @param name         name of the phase in the file. If this is the empty string, the first phase in the file is used.
     *  @param[in] adjacentLen Length of array reserved for adjacent.
     *  @param adjacent     Memory holding Solution objects. vector containing adjacent Solution objects. If empty, adjacent phases will be instantiated based on the phase definition.
     *  @returns            Handle to stored Interface object or -1 for exception handling.
     */
    int32_t sol_newInterface(const char* infile, const char* name, int32_t adjacentLen, const int32_t* adjacent);
 
    /**
     *  Delete Solution object.
     *
     *  Wraps C++ destructor: `undefined`
     *
     *  Uses:
     *  - `shared_ptr<ThermoPhase> Solution::thermo()`
     *  - `shared_ptr<Kinetics> Solution::kinetics()`
     *  - `shared_ptr<Transport> Solution::transport()`
     *
     *  @param handle       Handle to Solution object.
     *  @returns            Zero for success and -1 for exception handling.
     */
    int32_t sol_del(int32_t handle);
 
    /**
     *  Return the name of this Solution object.
     *
     *  Wraps C++ getter: `string Solution::name()`
     *
     *  @param handle       Handle to queried Solution 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 sol_name(int32_t handle, int32_t bufLen, char* buf);
 
    /**
     *  Set the name of this Solution object.
     *
     *  Wraps C++ setter: `void Solution::setName(const string&)`
     *
     *  @param handle       Handle to queried Solution object.
     *  @param name         Undocumented.
     */
    int32_t sol_setName(int32_t handle, const char* name);
 
    /**
     *  Accessor for the ThermoPhase pointer.
     *
     *  Wraps C++ getter: `shared_ptr<ThermoPhase> Solution::thermo()`
     *
     *  @param handle       Handle to queried Solution object.
     *  @returns            Handle to stored ThermoPhase object or -1 for exception handling.
     */
    int32_t sol_thermo(int32_t handle);
 
    /**
     *  Accessor for the Kinetics pointer.
     *
     *  Wraps C++ getter: `shared_ptr<Kinetics> Solution::kinetics()`
     *
     *  @param handle       Handle to queried Solution object.
     *  @returns            Handle to stored Kinetics object or -1 for exception handling.
     */
    int32_t sol_kinetics(int32_t handle);
 
    /**
     *  Accessor for the Transport pointer.
     *
     *  Wraps C++ getter: `shared_ptr<Transport> Solution::transport()`
     *
     *  @param handle       Handle to queried Solution object.
     *  @returns            Handle to stored Transport object or -1 for exception handling.
     */
    int32_t sol_transport(int32_t handle);
 
    /**
     *  Retrieve transport model name.
     *
     *  Wraps C++ getter: `string Solution::transportModel()`
     *
     *  @param handle       Handle to queried Solution 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 sol_transportModel(int32_t handle, int32_t bufLen, char* buf);
 
    /**
     *  Set the Transport object by name.
     *
     *  Wraps C++ accessor: `void Solution::setTransportModel(const string&)`
     *
     *  Uses:
     *  - `shared_ptr<Transport> Solution::transport()`
     *
     *  @param handle       Handle to queried Solution object.
     *  @param model        name of transport model; if omitted, the default model is used
     */
    int32_t sol_setTransportModel(int32_t handle, const char* model);
 
    /**
     *  Get the number of adjacent phases.
     *
     *  Wraps C++ getter: `size_t Solution::nAdjacent()`
     *
     *  @param handle       Handle to queried Solution object.
     */
    int32_t sol_nAdjacent(int32_t handle);
 
    /**
     *  Get the Solution object for an adjacent phase by index.
     *
     *  Wraps C++ accessor: `shared_ptr<Solution> Solution::adjacent(size_t)`
     *
     *  Uses:
     *  - `size_t Solution::nAdjacent()`
     *  - `shared_ptr<ThermoPhase> Solution::thermo()`
     *  - `shared_ptr<Kinetics> Solution::kinetics()`
     *  - `shared_ptr<Transport> Solution::transport()`
     *
     *  @param handle       Handle to queried Solution object.
     *  @param i            Undocumented.
     *  @returns            Handle to stored Solution object or -1 for exception handling.
     */
    int32_t sol_adjacent(int32_t handle, int32_t i);
 
    /**
     *  Get the name of an adjacent phase by index.
     *
     *  Wraps C++ method: `string Solution::adjacentName(size_t)`
     *
     *  @param handle       Handle to queried Solution object.
     *  @param i            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 sol_adjacentName(int32_t handle, int32_t i, int32_t bufLen, char* buf);
 
    /**
     *  Retrieve source used for object creation; usually an input file name.
     *
     *  Wraps C++ getter: `const string Solution::source()`
     *
     *  @param handle       Handle to queried Solution 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 sol_source(int32_t handle, int32_t bufLen, char* buf);
 
    /**
     *  Return size of Solution storage.
     *
     *  Wraps C++ reserved CLib function: `custom code`
     *
     *  @returns            Size or -1 for exception handling.
     */
    int32_t sol_cabinetSize();
 
    /**
     *  @}
     */
 
#ifdef __cplusplus
}
#endif
 
#endif // CTSOL_H