Reaktoro 
A unified framework for modeling chemically reactive systems
Reaktoro::Connectivity Class Reference

Detailed Description

A type to describe the connectivity of elements, species, and phases in a chemical system.

See also
ChemicalSystem, Element, Species, Phase

#include <Connectivity.hpp>

Public Member Functions

 Connectivity ()
 Construct a default Connectivity instance.
 
 Connectivity (const ChemicalSystem &system)
 Construct a Connectivity instance with given chemical system.
 
 Connectivity (const Connectivity &other)
 Construct a copy of a Connectivity instance.
 
virtual ~Connectivity ()
 Destroy this instance.
 
auto operator= (Connectivity other) -> Connectivity &
 Assign a Connectivity instance to this instance.
 
auto indicesElementsInSpecies (Index ispecies) const -> const Indices &
 Return the indices of the elements in a species. More...
 
auto indicesElementsInPhase (Index iphase) const -> const Indices &
 Return the indices of the elements in a phase. More...
 
auto indicesSpeciesInPhase (Index iphase) const -> const Indices &
 Return the indices of the species in a phase. More...
 
auto indicesSpeciesWithElement (Index ielement) const -> const Indices &
 Return the indices of the species with an element. More...
 
auto indicesPhasesWithElement (Index ielement) const -> const Indices &
 Return the indices of the phases with an element. More...
 
auto indexPhaseWithSpecies (Index ispecies) const -> Index
 Return the index of the phase with a species. More...
 

Member Function Documentation

auto Reaktoro::Connectivity::indicesElementsInSpecies ( Index  ispecies) const -> const Indices&

Return the indices of the elements in a species.

Parameters
ispeciesThe index of the species.
auto Reaktoro::Connectivity::indicesElementsInPhase ( Index  iphase) const -> const Indices&

Return the indices of the elements in a phase.

Parameters
iphaseThe index of the phase.
auto Reaktoro::Connectivity::indicesSpeciesInPhase ( Index  iphase) const -> const Indices&

Return the indices of the species in a phase.

Parameters
iphaseThe index of the phase.
auto Reaktoro::Connectivity::indicesSpeciesWithElement ( Index  ielement) const -> const Indices&

Return the indices of the species with an element.

Parameters
ielementThe index of the element.
auto Reaktoro::Connectivity::indicesPhasesWithElement ( Index  ielement) const -> const Indices&

Return the indices of the phases with an element.

Parameters
ielementThe index of the element.
auto Reaktoro::Connectivity::indexPhaseWithSpecies ( Index  ispecies) const -> Index

Return the index of the phase with a species.

Parameters
ispeciesThe index of the species.

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