Class SolutionArray

include/cantera/base/SolutionArray.h:32–405

A container class holding arrays of state information. ! * SolutionArray objects provide a convenient interface for representing many * thermodynamic states using the same Solution object. C++ SolutionArray objects are * one-dimensional by design; while shape information for multi-dimensional arrays is * stored, reshaping operations need to be implemented in high-level API's. * * The Solutio

 * @ingroup solnGroup
 */
class SolutionArray
{
private:
    SolutionArray(const shared_ptr<Solution>& sol,
                  int size,
                  const AnyMap& meta);

    SolutionArray(const SolutionArray& arr, const vector<int>& indices);

public:
    virtual ~SolutionArray();

    /**
     *  Instantiate a new SolutionArray reference.
     *
     *  @param sol  Solution object defining phase definitions
     *  @param size  Number of SolutionArray entries
     *  @param meta  AnyMap holding SolutionArray meta data
     */
    static shared_ptr<SolutionArray> create(const shared_ptr<Solution>& sol,
                                            int size=0,
                                            const AnyMap& meta={})
    {
        return shared_ptr<SolutionArray>(new SolutionArray(sol, size, meta));
    }

    /**
     *  Share locations from an existing SolutionArray and return new reference.
     *
     *  Both SolutionArray object share common data. The method is used for slicing
     *  of SolutionArrays from high-level API's. Note that meta data are not inherited.
     *  @param selected  List of locations for shared entries
     */
    shared_ptr<SolutionArray> share(const vector<int>& selected)
    {
        return shared_ptr<SolutionArray>(new SolutionArray(*this, selected));
    }

    //! Reset all entries of the SolutionArray to the current Solution state
    void reset();

    //! Size of SolutionArray (number of entries).
    int size() const {
        return static_cast<int>(m_size);
    }

    //! Resize SolutionArray objects with a single dimension (default).
    void resize(int size);

    //! SolutionArray shape information used by high-level API's.
    vector<long int> apiShape() const {
        return m_apiShape;
    }

    //! Set SolutionArray shape information used by high-level API's.
    //! The size of the SolutionArray is adjusted automatically.
    void setApiShape(const vector<long int>& shape);