Reaktoro  v2.0.0
A unified framework for modeling chemically reactive systems

Used to support thermodynamic databases in NASA CEA format. More...

#include <NasaDatabase.hpp>

Collaboration diagram for NasaDatabase:
[legend]

Public Member Functions

 NasaDatabase (Database database)
 Construct a NasaDatabase object using an object of Database.
 
 NasaDatabase (String name)
 Construct a NasaDatabase object using an embedded database file. More...
 
 Database ()
 Construct a default Database object.
 
 Database (const Database &other)
 Construct a copy of a Database object.
 
 Database (const Vec< Element > &elements, const Vec< Species > &species)
 Construct a Database object with given elements and species.
 
 Database (const Vec< Species > &species)
 Construct a Database object with given species (elements extracted from them).
 
- Public Member Functions inherited from Database
 Database ()
 Construct a default Database object.
 
 Database (const Database &other)
 Construct a copy of a Database object.
 
 Database (const Vec< Element > &elements, const Vec< Species > &species)
 Construct a Database object with given elements and species.
 
 Database (const Vec< Species > &species)
 Construct a Database object with given species (elements extracted from them).
 
 ~Database ()
 Destroy this Database object.
 
auto operator= (Database other) -> Database &
 Assign another Database object to this.
 
auto clear () -> void
 Remove all species and elements from the database.
 
auto addElement (const Element &element) -> void
 Add an element in the database. More...
 
auto addSpecies (const Species &species) -> void
 Add a species in the database. More...
 
auto addSpecies (const Vec< Species > &species) -> void
 Add a list of species in the database.
 
auto attachData (const Any &data) -> void
 Attach data to this database whose type is known at runtime only.
 
auto extend (const Database &other) -> void
 Extend this database with the elements, species and other contents from another database.
 
auto elements () const -> const ElementList &
 Return all elements in the database.
 
auto species () const -> const SpeciesList &
 Return all species in the database.
 
auto speciesWithAggregateState (AggregateState option) const -> SpeciesList
 Return all species in the database with given aggregate state.
 
auto element (const String &symbol) const -> const Element &
 Return an element with given symbol in the database. More...
 
auto species (const String &name) const -> const Species &
 Return a species with given name in the database. More...
 
auto reaction (const String &equation) const -> Reaction
 Construct a reaction with given equation. More...
 
auto attachedData () const -> const Any &
 Return the attached data to this database whose type is known at runtime only.
 

Static Public Member Functions

static auto withName (String name) -> NasaDatabase
 Return a NasaDatabase object initialized using an embedded NASA database. More...
 
- Static Public Member Functions inherited from Database
static auto fromFile (const String &path) -> Database
 Return a Database object constructed with a given local file. More...
 
static auto fromContents (const String &contents) -> Database
 Return a Database object constructed with given database text contents. More...
 
static auto fromStream (std::istream &stream) -> Database
 Return a Database object constructed with given input stream containing the database text contents. More...
 

Detailed Description

Used to support thermodynamic databases in NASA CEA format.

Constructor & Destructor Documentation

◆ NasaDatabase()

NasaDatabase ( String  name)

Construct a NasaDatabase object using an embedded database file.

The currently supported embedded NASA database files are named:

  • nasa-cea
    Parameters
    nameThe name of the embedded NASA database file
    Warning
    An exception is thrown if name is not one of the above supported names.

Member Function Documentation

◆ withName()

static auto withName ( String  name) -> NasaDatabase
static

Return a NasaDatabase object initialized using an embedded NASA database.

The currently supported embedded NASA database files are named:

  • nasa-cea
    Parameters
    nameThe name of the embedded NASA database file
    Warning
    An exception is thrown if name is not one of the above supported names.

The documentation for this class was generated from the following file: