api/NamingUtils_8hpp_source.html

 // Reaktoro is a unified framework for modeling chemically reactive systems.

 //

 // Copyright © 2014-2024 Allan Leal

 //

 // This library is free software; you can redistribute it and/or

 // modify it under the terms of the GNU Lesser General Public

 // License as published by the Free Software Foundation; either

 // version 2.1 of the License, or (at your option) any later version.

 //

 // This library is distributed in the hope that it will be useful,

 // but WITHOUT ANY WARRANTY; without even the implied warranty of

 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

 // Lesser General Public License for more details.

 //

 // You should have received a copy of the GNU Lesser General Public License

 // along with this library. If not, see <http://www.gnu.org/licenses/>.


 #pragma once


 // C++ includes

 #include <string>

 #include <vector>

 #include <cctype>


 namespace Reaktoro {


 auto alternativeWaterNames() -> std::vector<std::string>;


 auto alternativeChargedSpeciesNames(std::string name) -> std::vector<std::string>&;


 auto alternativeNeutralSpeciesNames(std::string name) -> std::vector<std::string>&;


 auto conventionalWaterName() -> std::string;


 auto conventionalChargedSpeciesName(std::string name) -> std::string;


 auto conventionalNeutralSpeciesName(std::string name) -> std::string;


 auto isAlternativeWaterName(std::string trial) -> bool;


 auto isAlternativeChargedSpeciesName(std::string trial, std::string name) -> bool;


 auto isAlternativeNeutralSpeciesName(std::string trial, std::string name) -> bool;


 auto splitChargedSpeciesName(std::string name) -> std::pair<std::string, double>;


 auto baseNameChargedSpecies(std::string name) -> std::string;


 auto baseNameNeutralSpecies(std::string name) -> std::string;


 auto chargeInSpeciesName(std::string name) -> double;


 auto splitSpeciesNameSuffix(std::string name) -> std::pair<std::string, std::string>;


 } // namespace Reaktoro

Reaktoro
The namespace containing all components of the Reaktoro library.
Definition: Algorithms.hpp:29

Reaktoro::isAlternativeWaterName
auto isAlternativeWaterName(std::string trial) -> bool
Return true if a trial name is an alternative to a water species name.

Reaktoro::splitChargedSpeciesName
auto splitChargedSpeciesName(std::string name) -> std::pair< std::string, double >
Return a pair with the base name of a charged species and its electrical charge.

Reaktoro::alternativeNeutralSpeciesNames
auto alternativeNeutralSpeciesNames(std::string name) -> std::vector< std::string > &
Return a collection of alternative names to the given neutral species name.

Reaktoro::conventionalNeutralSpeciesName
auto conventionalNeutralSpeciesName(std::string name) -> std::string
Return the conventional neutral species name adopted in Reaktoro.

Reaktoro::alternativeWaterNames
auto alternativeWaterNames() -> std::vector< std::string >
Return a collection of alternative names to the given species name.

Reaktoro::splitSpeciesNameSuffix
auto splitSpeciesNameSuffix(std::string name) -> std::pair< std::string, std::string >
Split name and suffix from a substance name or chemical formula.

Reaktoro::isAlternativeChargedSpeciesName
auto isAlternativeChargedSpeciesName(std::string trial, std::string name) -> bool
Return true if a trial name is an alternative to a given charged species name.

Reaktoro::conventionalWaterName
auto conventionalWaterName() -> std::string
Return the conventional water name, which is H2O(l).

Reaktoro::chargeInSpeciesName
auto chargeInSpeciesName(std::string name) -> double
Return the electrical charge in a species name.

Reaktoro::baseNameChargedSpecies
auto baseNameChargedSpecies(std::string name) -> std::string
Return the name of a charged species without charge suffix.

Reaktoro::conventionalChargedSpeciesName
auto conventionalChargedSpeciesName(std::string name) -> std::string
Return the conventional charged species name adopted in Reaktoro.

Reaktoro::baseNameNeutralSpecies
auto baseNameNeutralSpecies(std::string name) -> std::string
Return the name of a neutral species without suffix (aq).

Reaktoro::alternativeChargedSpeciesNames
auto alternativeChargedSpeciesNames(std::string name) -> std::vector< std::string > &
Return a collection of alternative names to the given charged species name.

Reaktoro::isAlternativeNeutralSpeciesName
auto isAlternativeNeutralSpeciesName(std::string trial, std::string name) -> bool
Return true if a trial name is an alternative to a given neutral species name.