krakentools.groupconstants.genpoly.getters.get_all_gcs

krakentools.groupconstants.genpoly.getters.get_all_gcs(hg_uni, gc_type, dc_type, version, fit_inverse_of_D, pu_corr_mdep_idx, mdep_global_region_indices, global_mdep_data)
Gets all group constants required in the parametrization of the

polynomial GC model from HomogUniv. Includes some things that are not actually output to the library.

Parameters:

  • hg_uni (HomogUniv) – A SerpentTools HomogUniv object containing group constant generation data.

  • gc_type (GCTypes) – The type of group constant to get (INF, B1)

  • dc_type (DCTypes) – The type of diffusion constant to get (INF, B1, CMM, TRC)

  • version (int, optional) – Library version to fit with. Currently affects samarium treatment. Defaults to 1.

  • fit_inverse_of_D (bool, optional) – Option to parametrize 1/D instead of D. Defaults to False.

  • pu_corr_mdep_idx (int) – The index of the mdep card that should be used for plutonium history correction.

  • mdep_global_region_indices (Tuple[int, ...]) – {Tuple[int, …]} – Contains indices of this hg_uni’s mdep regions in the global indexing. Should be an empty tuple if no microdepletion data is included.

  • global_mdep_data (Optional[MicroDepData]) – {Optional[MicroDepData]} – A MicroDepData instance (or None) describing the global mdep regions and matrices. Can contain more regions than this hg_uni.

Returns:

A tuple containing data (in a np array) for each group constant.

Return type:

Tuple[np.ndarray]