GridFire v0.7.6rc4.0 General Purpose Nuclear Network

Loading...
Searching...
No Matches
Data Types | Enumerations | Functions/Subroutines | Variables
gridfire_mod Module Reference

## Data Types
interface | gf_construct_engine_from_policy
interface | gf_construct_solver_from_engine
interface | gf_evolve_c_array
interface | gf_evolve_c_scalar
interface | gf_free
interface | gf_get_last_error_message
interface | gf_init
interface | gf_register_species
interface | gf_set_num_zones
type | gf_type
type | gridfire

## Enumerations
enum | { fdsse_non_4dstar_error = -102 , fdsse_unknown_error = -101 , fdsse_success = 1 , fdsse_unknown_symbol_error = 100 , fdsse_species_error = 101 , fdsse_invalid_composition_error = 102 , fdsse_composition_error = 103 , gf_non_gridfire_error = -2 , gf_unknown_error = -1 , gf_success = 0 , gf_invalid_qse_solution_error = 5 , gf_failed_to_partition_error = 6 , gf_network_resized_error = 7 , gf_unable_to_set_network_reactions_error = 8 , gf_bad_collection_error = 9 , gf_bad_rhs_enigne_error = 10 , gf_stale_jacobian_error = 11 , gf_uninitialized_jacobian_error = 12 , gf_unknonwn_jacobian_error = 13 , gf_jacobian_error = 14 , gf_engine_error = 15 , gf_missing_base_reaction_error = 16 , gf_missing_seed_species_error = 17 , gf_missing_key_reaction_error = 18 , gf_policy_error = 19 , gf_reaction_parsing_error = 20 , gf_reactoion_error = 21 , gf_singular_jacobian_error = 22 , gf_ill_conditioned_jacobian_error = 23 , gf_cvode_solver_failure_error = 24 , gf_kinsol_solver_failure_error = 25 , gf_sundials_error = 26 , gf_solver_error = 27 , gf_hashing_error = 28 , gf_utility_error = 29 , gf_debug_errror = 30 , gf_gridfire_error = 31 , gf_uninitialized_input_memory_error = 32 , gf_uninitialized_output_memory_error = 33 , gf_invald_num_species = 34 , gf_invalid_timesteps = 35 , gf_unknonwn_free_type = 36 , gf_invalid_type = 37 , gf_single_zone = 1001 , gf_multi_zone = 1002 }

## Functions/Subroutines
subroutine | gff_init (self, type, zones)
subroutine | gff_free (self)
character(len=:) function, allocatable | gff_get_last_error (self)
subroutine | gff_register_species (self, species_list)
subroutine | gff_setup_policy (self, policy_name, abundances)
subroutine | gff_setup_solver (self, solver_name)
subroutine | gff_evolve_single (self, y_in, t, rho, tmax, dt0, y_out, energy, dedt, dedrho, nu_e_loss, nu_flux, mass_lost, ierr)
subroutine | gff_evolve_multi (self, y_in, t, rho, tmax, dt0, y_out, energy, dedt, dedrho, nu_e_loss, nu_flux, mass_lost, ierr)

## Variables
type(gf_type), parameter, public | single_zone = GF_TYPE(1001)
type(gf_type), parameter, public | multi_zone = GF_TYPE(1002)

## Enumeration Type Documentation

## ◆ anonymous enum

anonymous enum

Enumerator
fdsse_non_4dstar_error |
fdsse_unknown_error |
fdsse_success |
fdsse_unknown_symbol_error |
fdsse_species_error |
fdsse_invalid_composition_error |
fdsse_composition_error |
gf_non_gridfire_error |
gf_unknown_error |
gf_success |
gf_invalid_qse_solution_error |
gf_failed_to_partition_error |
gf_network_resized_error |
gf_unable_to_set_network_reactions_error |
gf_bad_collection_error |
gf_bad_rhs_enigne_error |
gf_stale_jacobian_error |
gf_uninitialized_jacobian_error |
gf_unknonwn_jacobian_error |
gf_jacobian_error |
gf_engine_error |
gf_missing_base_reaction_error |
gf_missing_seed_species_error |
gf_missing_key_reaction_error |
gf_policy_error |
gf_reaction_parsing_error |
gf_reactoion_error |
gf_singular_jacobian_error |
gf_ill_conditioned_jacobian_error |
gf_cvode_solver_failure_error |
gf_kinsol_solver_failure_error |
gf_sundials_error |
gf_solver_error |
gf_hashing_error |
gf_utility_error |
gf_debug_errror |
gf_gridfire_error |
gf_uninitialized_input_memory_error |
gf_uninitialized_output_memory_error |
gf_invald_num_species |
gf_invalid_timesteps |
gf_unknonwn_free_type |
gf_invalid_type |
gf_single_zone |
gf_multi_zone |

## Function/Subroutine Documentation

## ◆ gff_evolve_multi()

subroutine gridfire_mod::gff_evolve_multi | ( | class(gridfire), intent(in) | self,
|  | real(c_double), dimension(:,:), intent(in) | y_in,
|  | real(c_double), dimension(:), intent(in) | t,
|  | real(c_double), dimension(:), intent(in) | rho,
|  | real(c_double), value | tmax,
|  | real(c_double), value | dt0,
|  | real(c_double), dimension(:,:), intent(out) | y_out,
|  | real(c_double), dimension(:), intent(out) | energy,
|  | real(c_double), dimension(:), intent(out) | dedt,
|  | real(c_double), dimension(:), intent(out) | dedrho,
|  | real(c_double), dimension(:), intent(out) | nu_e_loss,
|  | real(c_double), dimension(:), intent(out) | nu_flux,
|  | real(c_double), dimension(:), intent(out) | mass_lost,
|  | integer, intent(out) | ierr )

## ◆ gff_evolve_single()

subroutine gridfire_mod::gff_evolve_single | ( | class(gridfire), intent(in) | self,
|  | real(c_double), dimension(:), intent(in) | y_in,
|  | real(c_double), intent(in) | t,
|  | real(c_double), intent(in) | rho,
|  | real(c_double), value | tmax,
|  | real(c_double), value | dt0,
|  | real(c_double), dimension(:), intent(out) | y_out,
|  | real(c_double), intent(out) | energy,
|  | real(c_double), intent(out) | dedt,
|  | real(c_double), intent(out) | dedrho,
|  | real(c_double), intent(out) | nu_e_loss,
|  | real(c_double), intent(out) | nu_flux,
|  | real(c_double), intent(out) | mass_lost,
|  | integer, intent(out) | ierr )

## ◆ gff_free()

subroutine gridfire_mod::gff_free | ( | class(gridfire), intent(inout) | self | ) |

## ◆ gff_get_last_error()

character(len=:) function, allocatable gridfire_mod::gff_get_last_error | ( | class(gridfire), intent(in) | self | ) |

## ◆ gff_init()

subroutine gridfire_mod::gff_init | ( | class(gridfire), intent(out) | self,
|  | type(gf_type), intent(in) | type,
|  | integer(c_size_t), intent(in), optional | zones )

## ◆ gff_register_species()

subroutine gridfire_mod::gff_register_species | ( | class(gridfire), intent(inout) | self,
|  | character(len=*), dimension(:), intent(in) | species_list )

## ◆ gff_setup_policy()

subroutine gridfire_mod::gff_setup_policy | ( | class(gridfire), intent(in) | self,
|  | character(len=*), intent(in) | policy_name,
|  | real(c_double), dimension(:), intent(in) | abundances )

## ◆ gff_setup_solver()

subroutine gridfire_mod::gff_setup_solver | ( | class(gridfire), intent(in) | self,
|  | character(len=*), intent(in) | solver_name )

## Variable Documentation

## ◆ multi_zone

type(gf_type), parameter, public gridfire_mod::multi_zone = GF_TYPE(1002)

## ◆ single_zone

type(gf_type), parameter, public gridfire_mod::single_zone = GF_TYPE(1001)