CADETProcess.processModel.Process.add_parameter_sensitivity

Process.add_parameter_sensitivity(parameter_paths, name=None, components=None, polynomial_coefficients=None, reaction_indices=None, bound_state_indices=None, section_indices=None, abstols=None, factors=None)

Add parameter sensitivty to Process.

Parameters:

parameter_pathsstr or list of str

The path to the parameter(s).

namestr, optional

The name of the parameter sensitivity. If not provided, the name of the first parameter will be used.

componentsstr or list of str, optional

The component(s) to which the parameter(s) belong. Must only be provided if parameter is specific to a certain compoment.

polynomial_coefficients: str or list of str, optional

The polynomial coefficients(s) to which the parameter(s) belong. Must only be provided if parameter is specific to a certain coefficient.

reaction_indicesint or list of int, optional

The index(es) of the reaction(s) in the associated model(s), if applicable. Must only be provided if parameter is specific to a certain reaction.

bound_state_indicesint or list of int, optional

The index(es) of the bound state(s) in the associated model(s), if applicable. Must only be provided if parameter is specific to a certain bound state.

section_indicesint or list of int, optional

The index(es) of the section(s) in the associated model(s), if applicable. If not provided, Must only be provided if parameter is specific to a certain section.

abstolsfloat or list of float, optional

The absolute tolerances for each parameter. If not provided, a default tolerance will be used.

factorsfloat or list of float, optional

The factors for each parameter. If not provided, a default factor of 1 will be used.

Raises:

CADETProcessError

Number of indices do not match for: - components - polynomial_coefficients - reaction - bound_state - sections - tolerances - factors

Component is not found. Unit is not found. Parameter is not found. Name is not provided (if number of parameters larger than 1). If sensitivity name already exists.

Notes

This functionality is still work in progress.

Todo

• [ ] Check if compoment/reaction/polynomial index are required.

• [ ] Specify time instead of section index;