feat(python): Repaired python bindings
Python bindings have now been brought back up to feature pairity with C++. Further, stubs have been added for all python features so that code completion will work
This commit is contained in:
@@ -31,54 +31,4 @@ namespace gridfire::engine {
|
||||
GraphEngine& engine,
|
||||
const std::optional<std::vector<reaction::ReactionType>>& ignoredReactionTypes
|
||||
);
|
||||
|
||||
/**
|
||||
* @brief Computes the destruction rate constant for a specific species.
|
||||
*
|
||||
* Calculates the sum of molar reaction flows for all reactions where the species
|
||||
* is a reactant (negative stoichiometry) after scaling its abundance to unity.
|
||||
*
|
||||
* @param engine Engine providing the current set of network reactions and flow calculations.
|
||||
* @param species The atomic species whose destruction rate is computed.
|
||||
* @param composition Current composition providing abundances for all species.
|
||||
* @param T9 Temperature in units of 10^9 K.
|
||||
* @param rho Density of the medium.
|
||||
* @param reactionTypesToIgnore types of reactions to ignore during calculation.
|
||||
* @pre Y.size() matches engine.getNetworkReactions().size() mapping species order.
|
||||
* @post Returned rate constant is non-negative.
|
||||
* @return Sum of absolute stoichiometry-weighted destruction flows for the species.
|
||||
*/
|
||||
double calculateDestructionRateConstant(
|
||||
const DynamicEngine& engine,
|
||||
const fourdst::atomic::Species& species,
|
||||
const fourdst::composition::Composition& composition,
|
||||
double T9,
|
||||
double rho,
|
||||
const std::optional<std::vector<reaction::ReactionType>> &reactionTypesToIgnore
|
||||
);
|
||||
|
||||
/**
|
||||
* @brief Computes the creation rate for a specific species.
|
||||
*
|
||||
* Sums molar reaction flows for all reactions where the species
|
||||
* appears as a product (positive stoichiometry).
|
||||
*
|
||||
* @param engine Engine providing the current set of network reactions and flow calculations.
|
||||
* @param species The atomic species whose creation rate is computed.
|
||||
* @param composition Composition object containing current abundances.
|
||||
* @param T9 Temperature in units of 10^9 K.
|
||||
* @param rho Density of the medium.
|
||||
* @param reactionTypesToIgnore types of reactions to ignore during calculation.
|
||||
* @pre Y.size() matches engine.getNetworkReactions().size() mapping species order.
|
||||
* @post Returned creation rate is non-negative.
|
||||
* @return Sum of stoichiometry-weighted creation flows for the species.
|
||||
*/
|
||||
double calculateCreationRate(
|
||||
const DynamicEngine& engine,
|
||||
const fourdst::atomic::Species& species,
|
||||
const fourdst::composition::Composition& composition,
|
||||
double T9,
|
||||
double rho,
|
||||
const std::optional<std::vector<reaction::ReactionType>> &reactionTypesToIgnore
|
||||
);
|
||||
}
|
||||
Reference in New Issue
Block a user