Technical Elements Documentation
    Preparing search index...

    Interface FaultTree

    Interface for a complete fault tree

    SY-A1

    interface FaultTree {
        assumptions?: string[];
        attributes?: { name: string; value: string }[];
        components?: { description?: string; id: string; name: string }[];
        description: string;
        gates?: Record<
            string,
            {
                description?: string;
                id: string;
                inputs: { id: string }[];
                k?: number;
                name: string;
                type: string;
            },
        >;
        minimalCutSets?: string[][];
        nodes: Record<string, FaultTreeNode>;
        quantificationSettings?: {
            maxOrder?: number;
            method?: "mincut" | "exact" | "rare-event" | "mcub";
            truncationLimit?: number;
        };
        saphireCompatibility?: {
            openPsaFieldMappings?: Record<string, string>;
            saphireFieldMappings?: SaphireFieldMapping[];
        };
        systemReference: systems_analysis.SystemReference;
        topEventId: string;
        topEventProbability?: number;
        topEventReference?: string;
        validateSpecialEvents(): boolean;
    }

    Hierarchy

    • Unique
    • Named
      • FaultTree
    Index

    Methods

    validateSpecialEvents

    Properties

    assumptions? attributes? components? description gates? minimalCutSets? nodes quantificationSettings? saphireCompatibility? systemReference topEventId topEventProbability? topEventReference?

    Methods

    • Validates special events in the fault tree

      Returns boolean

      true if all special events are valid, false otherwise

    Properties

    assumptions?: string[]

    Assumptions made in the fault tree analysis

    attributes?: { name: string; value: string }[]

    Attributes for quantification adapter These are used by the adapter to provide additional information to the quantification engine

    components?: { description?: string; id: string; name: string }[]

    Components referenced in this fault tree Used by the quantification adapter for component mapping

    description: string

    Description of the fault tree

    gates?: Record<
        string,
        {
            description?: string;
            id: string;
            inputs: { id: string }[];
            k?: number;
            name: string;
            type: string;
        },
    >

    Gates in the fault tree - this structure aligns with the quantification adapter expectations

    This field can be derived from nodes but is provided explicitly for adapter compatibility

    minimalCutSets?: string[][]

    Minimal cut sets as arrays of basic event IDs

    nodes: Record<string, FaultTreeNode>

    Map of node IDs to nodes

    quantificationSettings?: {
        maxOrder?: number;
        method?: "mincut" | "exact" | "rare-event" | "mcub";
        truncationLimit?: number;
    }

    Quantification settings

    saphireCompatibility?: {
        openPsaFieldMappings?: Record<string, string>;
        saphireFieldMappings?: SaphireFieldMapping[];
    }

    Optional SAPHIRE compatibility fields

    Type declaration

    • OptionalopenPsaFieldMappings?: Record<string, string>

      OpenPSA/SCRAM compatibility mappings

    • OptionalsaphireFieldMappings?: SaphireFieldMapping[]

      Field mappings between OpenPRA and SAPHIRE

    systemReference: systems_analysis.SystemReference

    Reference to the system this fault tree belongs to

    topEventId: string

    ID of the top event node within this fault tree's nodes map This is an internal reference to identify which node in the fault tree represents the top event

    SY-A1

    topEventProbability?: number

    Calculated probability of the top event

    SY-C1(o): results of the system model evaluations

    topEventReference?: string

    Reference to a top event from the core events module This allows linking the fault tree to a formally defined TopEvent in the core/events.ts file This is different from topEventId, which references a node within this fault tree

    Settings

    Member Visibility

    On This Page

    Methods
    Properties