desc.objectives.Omnigenity.compute

Omnigenity.compute(params_1=None, params_2=None, constants=None)Source

Compute omnigenity errors.

Parameters:

  • params_1 (dict) – If eq_fixed=True, dictionary of field degrees of freedom, eg OmnigenousField.params_dict. Otherwise, dictionary of equilibrium degrees of freedom, eg Equilibrium.params_dict.

  • params_2 (dict) – If eq_fixed=False and field_fixed=False, dictionary of field degrees of freedom, eg OmnigenousField.params_dict. Otherwise None.

  • constants (dict) – Dictionary of constant data, eg transforms, profiles etc. Defaults to self.constants

Returns:

omnigenity_error (ndarray) – Omnigenity error at each node (T).