Skip to content

docs-md


Interface: SystemSensitivityStudy

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/systems-analysis/systems-analysis.ts:1805

Interface for sensitivity studies on system models.

Extends

Properties

description

description: string

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/core/shared-patterns.ts:86

Description of the sensitivity study

Inherited from

SensitivityStudy.description


elementSpecificProperties?

optional elementSpecificProperties: Record<string, unknown>

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/core/shared-patterns.ts:113

Technical element specific properties Allows for extension with properties specific to a technical element

Inherited from

SensitivityStudy.elementSpecificProperties


impact?

optional impact: string

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/core/shared-patterns.ts:104

Impact on analysis outcomes

Inherited from

SensitivityStudy.impact


impactOnSystem

impactOnSystem: string

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/systems-analysis/systems-analysis.ts:1821

Impact on the system performance.

Example

ts
"Increased top event probability by 10%"

insights?

optional insights: string

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/systems-analysis/systems-analysis.ts:1828

Insights gained from the sensitivity study. This should be a comma-separated string of insights rather than an array to maintain compatibility with the parent SensitivityStudy interface.

Overrides

SensitivityStudy.insights


modelUncertaintyId?

optional modelUncertaintyId: string

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/core/shared-patterns.ts:107

Reference to the model uncertainty being studied

Inherited from

SensitivityStudy.modelUncertaintyId


name?

optional name: string

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/core/shared-patterns.ts:83

Name or title of the sensitivity study

Inherited from

SensitivityStudy.name


parameterChanged

parameterChanged: string

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/systems-analysis/systems-analysis.ts:1815

Parameter changed in the sensitivity study.

Example

ts
"Pump Failure Rate"

parameterRanges

parameterRanges: Record<string, [number, number]>

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/core/shared-patterns.ts:95

Range of variation for each parameter Record where key is parameter name and value is [min, max] tuple

Inherited from

SensitivityStudy.parameterRanges


results?

optional results: string

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/core/shared-patterns.ts:98

Results of the sensitivity study

Inherited from

SensitivityStudy.results


system

system: SystemReference

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/systems-analysis/systems-analysis.ts:1809

The system being analyzed.


uuid

uuid: Format<"uuid">

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/core/meta.ts:20

Inherited from

SensitivityStudy.uuid


variedParameters

variedParameters: string[]

Defined in: packages/docs-md/.tmp/typedoc-sanitized/mef-types/lib/core/shared-patterns.ts:89

Parameters being varied in the study

Inherited from

SensitivityStudy.variedParameters