krakentools.ants.evaluate_ffs_and_adfs_with_ants

krakentools.ants.evaluate_ffs_and_adfs_with_ants(nb_list, gc_type, dc_type, pin_table=None, evaluate_adfs=True, evaluate_ffs=True, n_proc=1, n_iter_max=1000, identifier='x', plot_homo_flux=False, critical_node_method=AntsCriticalNodes.MODE_FLUX_LIMIT, eigenvalue_critical_limit=5e-07, eigenvalue_real_limit=1e-13)
Runs an Ants single node calculation with data from each NodeBranch in nb_list,

gets homogeneous fluxes required to evaluate ADFs and pin power FFs, stores homogeneous data to NodeBranch.gc_uni and in the case of ADFs actually calculates and stores the new DFs to NodeBranch.gc_uni. In the case of form functions, only the homogeneous pin cell powers are evaluated and stored in NodeBranch.gc_uni. The form functions are evaluated later in the getter of the group constant parametrization.

Parameters:

  • nb_list (List[NodeBranch]) – A list of NodeBranch objects to process

  • gc_type (GCTypes) – Which group constant type should be used in the nodal solution.

  • dc_type (DCTypes) – Which diffusion coefficient type should be used in the nodal solution.

  • pin_table (Optional[PinTable], optional) – A PinTable object describing the pin-cells for which the form functions should be generated. Lattice positions in Serpent that do not match centerpoints in PinTable are removed from hg_uni. (can be used to skip guide tubes) Defaults to None.

  • evaluate_adfs (bool, optional) – Should the ADFs be evaluated? Defaults to True.

  • evaluate_ffs (bool, optional) – Should the form functions be evaluated? Defaults to True.

  • n_proc (int, optional) – Number of parallel processes to use. Defaults to 1.

  • n_iter_max (int, optional) – Maximum number of outer iterations for Ants solution. Defaults to 1000.

  • identifier (str, optional) – Assembly identifier for naming plot output. Defaults to x.

  • plot_homo_flux (bool, optional) – Plot Ants homogeneous flux solution? Defaults to False.

  • critical_node_method (AntsCriticalNodes, optional) – The approach to use in Ants to treat critical nodes. Default: AntsCriticalNodes.MODE_FLUX_LIMIT

  • eigenvalue_critical_limit (float, optional) – The limit for eigenvalue to consider a node critical in Ants simulation. Default: 5e-7

  • eigenvalue_real_limit (float, optional) – eigenvalue_real_limit parameter for Ants. Default: 1e-13

Return type:

None