|
GridFire v1.2.0
General Purpose Nuclear Network
|
#include "gridfire/gridfire.h"#include "fourdst/composition/exceptions/exceptions_composition.h"#include "gridfire/extern/gridfire_context.h"#include "gridfire/extern/gridfire_extern.h"Concepts | |
| concept | @076141075253251206006125172343113355315141050267::ErrorTrackable |
Functions | |
| void * | gf_init (const enum GF_TYPE type) |
| int | gf_free (const enum GF_TYPE type, void *ctx) |
| int | gf_set_num_zones (const enum GF_TYPE type, void *ptr, const size_t num_zones) |
| int | gf_register_species (void *ptr, const int num_species, const char **species_names) |
| int | gf_construct_engine_from_policy (void *ptr, const char *policy_name, const double *abundances, const size_t num_species) |
| int | gf_construct_solver_from_engine (void *ptr) |
| int | gf_evolve (const enum GF_TYPE type, void *ptr, const void *Y_in, const size_t num_species, const void *T, const void *rho, const double tMax, const double dt0, void *Y_out, void *energy_out, void *dEps_dT, void *dEps_dRho, void *specific_neutrino_energy_loss, void *specific_neutrino_flux, void *mass_lost, void *eps_nuc, void *dlnEps_dlnT, void *dlnEps_dlnRho, void *neutrino_energy_loss_rate, void *eps_by_channel) |
| int | gf_get_num_energy_channels (void *ptr, size_t *num_channels) |
| int | gf_get_energy_channel_name (void *ptr, const size_t index, const char **name) |
| char * | gf_get_last_error_message (void *ptr) |
| char * | gf_error_code_to_string (const int error_code) |
| int gf_construct_engine_from_policy | ( | void * | ptr, |
| const char * | policy_name, | ||
| const double * | abundances, | ||
| const size_t | num_species ) |
| int gf_construct_solver_from_engine | ( | void * | ptr | ) |
| char * gf_error_code_to_string | ( | const int | error_code | ) |
| int gf_evolve | ( | enum GF_TYPE | type, |
| void * | ptr, | ||
| const void * | Y_in, | ||
| size_t | num_species, | ||
| const void * | T, | ||
| const void * | rho, | ||
| double | tMax, | ||
| double | dt0, | ||
| void * | Y_out, | ||
| void * | energy_out, | ||
| void * | dEps_dT, | ||
| void * | dEps_dRho, | ||
| void * | specific_neutrino_energy_loss, | ||
| void * | specific_neutrino_flux, | ||
| void * | mass_lost, | ||
| void * | eps_nuc, | ||
| void * | dlnEps_dlnT, | ||
| void * | dlnEps_dlnRho, | ||
| void * | neutrino_energy_loss_rate, | ||
| void * | eps_by_channel ) |
Evolve one zone (SINGLE_ZONE) or every zone (MULTI_ZONE) for tMax seconds.
For MULTI_ZONE, T, rho, and every scalar output are arrays with one entry per zone, and Y_in / Y_out hold num_species abundances per zone.
Outputs: energy_out - specific energy released over tMax [erg/g] dEps_dT, dEps_dRho - partial derivatives of eps_nuc at the final state (fixed composition) specific_neutrino_energy_loss - neutrino energy lost over tMax [erg/g] specific_neutrino_flux - neutrinos emitted over tMax [1/g] mass_lost - mass in species outside the registered species list eps_nuc - instantaneous energy generation rate at the final state, net of neutrinos [erg/g/s] dlnEps_dlnT, dlnEps_dlnRho - logarithmic derivatives of eps_nuc (0 if eps_nuc == 0) neutrino_energy_loss_rate - instantaneous reaction neutrino loss rate at the final state [erg/g/s] eps_by_channel - eps_nuc split by energy channel, num_channels entries per zone (see gf_get_num_energy_channels); sums to eps_nuc
eps_nuc, its derivatives, and eps_by_channel are all evaluated at the same final state.
| int gf_free | ( | const enum GF_TYPE | type, |
| void * | ctx ) |
| int gf_get_energy_channel_name | ( | void * | ptr, |
| size_t | index, | ||
| const char ** | name ) |
Name of energy channel index (e.g. "H_pp", "H_CNO", "He"). The string is owned by the context.
| char * gf_get_last_error_message | ( | void * | ptr | ) |
| int gf_get_num_energy_channels | ( | void * | ptr, |
| size_t * | num_channels ) |
Number of energy channels reported per zone by gf_evolve (valid once the engine has been constructed).
| void * gf_init | ( | const enum GF_TYPE | type | ) |
| int gf_register_species | ( | void * | ptr, |
| const int | num_species, | ||
| const char ** | species_names ) |
| int gf_set_num_zones | ( | const enum GF_TYPE | type, |
| void * | ptr, | ||
| const size_t | num_zones ) |