gemseo / uncertainty / sensitivity

Show inherited members

factory module

A factory of sensitivity analyses.

class gemseo.uncertainty.sensitivity.factory.SensitivityAnalysisFactory[source]

Bases: BaseFactory

A factory of sensitivity analyses.

Return type:

Any

create(sensitivity_analysis, disciplines, parameter_space, n_samples=None, output_names=(), algo='', algo_options=mappingproxy({}), formulation='MDF', **formulation_options)[source]

Create the sensitivity analysis.

Parameters:
  • sensitivity_analysis (str) – The name of a class defining a sensitivity analysis.

  • disciplines (Collection[MDODiscipline]) – The discipline or disciplines to use for the analysis.

  • parameter_space (ParameterSpace) – A parameter space.

  • n_samples (int | None) – A number of samples. If None, the number of samples is computed by the algorithm.

  • output_names (Iterable[str]) –

    The disciplines’ outputs to be considered for the analysis. If empty, use all the outputs.

    By default it is set to ().

  • algo (str) –

    The name of the DOE algorithm. If empty, use the BaseSensitivityAnalysis.DEFAULT_DRIVER.

    By default it is set to “”.

  • algo_options (Mapping[str, DriverLibraryOptionType]) –

    The options of the DOE algorithm.

    By default it is set to {}.

  • formulation (str) –

    The name of the MDOFormulation to sample the disciplines.

    By default it is set to “MDF”.

  • **formulation_options (Any) – The options of the MDOFormulation.

Returns:

A sensitivity analysis.

Raises:

TypeError – If the class cannot be instantiated.

Return type:

BaseSensitivityAnalysis

property available_sensitivity_analyses: list[str]

The available classes for sensitivity analysis.

failed_imports: dict[str, str]

The class names bound to the import errors.