Class: BranchSwitch

Specification for switching from a detected bifurcation point to a new branch (periodic orbits from Hopf, fold continuation, etc.). Each BranchSwitch says: “from which special point on the parent branch, continue what kind of object, with what settings.” Override parent solver settings via the inline continuation field — only explicitly set attributes take effect; everything else is inherited from the parent Continuation.

URI: tvbo:class/BranchSwitch

 classDiagram
    class BranchSwitch
    click BranchSwitch href "./BranchSwitch.html"
      BranchSwitch : bothside
        
          
    
        
        
        BranchSwitch --> "0..1" Boolean : bothside
        click Boolean href "../http://www.w3.org/2001/XMLSchema#boolean.html"
    

        
      BranchSwitch : continuation
        
          
    
        
        
        BranchSwitch --> "0..1" Continuation : continuation
        click Continuation href "./Continuation.html"
    

        
      BranchSwitch : delta_p
        
          
    
        
        
        BranchSwitch --> "0..1" Float : delta_p
        click Float href "../http://www.w3.org/2001/XMLSchema#float.html"
    

        
      BranchSwitch : description
        
          
    
        
        
        BranchSwitch --> "0..1" String : description
        click String href "../http://www.w3.org/2001/XMLSchema#string.html"
    

        
      BranchSwitch : discretization
        
          
    
        
        
        BranchSwitch --> "0..1" Discretization : discretization
        click Discretization href "./Discretization.html"
    

        
      BranchSwitch : name
        
          
    
        
        
        BranchSwitch --> "1" String : name
        click String href "../http://www.w3.org/2001/XMLSchema#string.html"
    

        
      BranchSwitch : options
        
          
    
        
        
        BranchSwitch --> "*" Option : options
        click Option href "./Option.html"
    

        
      BranchSwitch : parameters
        
          
    
        
        
        BranchSwitch --> "*" Parameter : parameters
        click Parameter href "./Parameter.html"
    

        
      BranchSwitch : source_point
        
          
    
        
        
        BranchSwitch --> "0..1" String : source_point
        click String href "../http://www.w3.org/2001/XMLSchema#string.html"
    

        
      

Slots

Name Cardinality and Range Description Inheritance
name 1
xsd:string
direct
description 0..1
xsd:string
direct
parameters *
Parameter
direct
source_point 0..1
xsd:string
Which bifurcation point to start from direct
delta_p 0..1
xsd:float
Initial parameter offset from the bifurcation point direct
continuation 0..1
Continuation
Override solver settings for this branch direct
discretization 0..1
Discretization
Discretization method for the branch solution direct
bothside 0..1
xsd:boolean
Continue branch in both directions direct
options *
Option
Toolkit-specific string options for this branch (linear solver, etc direct

Usages

used by used in type used
Continuation branches range BranchSwitch

Identifier and Mapping Information

Schema Source

  • from schema: https://w3id.org/tvbo

Mappings

Mapping Type Mapped Value
self tvbo:BranchSwitch
native tvbo:BranchSwitch

LinkML Source

Direct

name: BranchSwitch
description: 'Specification for switching from a detected bifurcation point to a new
  branch (periodic orbits from Hopf, fold continuation, etc.). Each BranchSwitch says:
  "from which special point on the parent branch, continue what kind of object, with
  what settings." Override parent solver settings via the inline continuation field
  — only explicitly set attributes take effect; everything else is inherited from
  the parent Continuation.'
from_schema: https://w3id.org/tvbo
slots:
- name
- description
- parameters
attributes:
  source_point:
    name: source_point
    description: 'Which bifurcation point to start from. Syntax: - ''hopf:-1'' = last
      Hopf (default) - ''hopf:all'' = all Hopf points - ''hopf:1'' = first Hopf -
      ''fold:2'' = second fold - integer = specific special point index'
    from_schema: https://w3id.org/tvbo
    domain_of:
    - InitialState
    - BranchSwitch
    range: string
  delta_p:
    name: delta_p
    description: Initial parameter offset from the bifurcation point.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - BranchSwitch
    range: float
  continuation:
    name: continuation
    description: Override solver settings for this branch. Uses the same Continuation
      type — only explicitly set attributes override the parent's values.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - BranchSwitch
    range: Continuation
    inlined: true
  discretization:
    name: discretization
    description: Discretization method for the branch solution. Required for periodic
      orbit branches (Hopf → PO). Not needed for codim-2 branches (fold/Hopf continuation).
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - BranchSwitch
    - PDESolver
    range: Discretization
    inlined: true
  bothside:
    name: bothside
    description: Continue branch in both directions.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - BranchSwitch
    - Continuation
    range: boolean
  options:
    name: options
    description: Toolkit-specific string options for this branch (linear solver, etc.).
    from_schema: https://w3id.org/tvbo
    domain_of:
    - Discretization
    - BranchSwitch
    - Continuation
    range: Option
    multivalued: true
    inlined: true

Induced

name: BranchSwitch
description: 'Specification for switching from a detected bifurcation point to a new
  branch (periodic orbits from Hopf, fold continuation, etc.). Each BranchSwitch says:
  "from which special point on the parent branch, continue what kind of object, with
  what settings." Override parent solver settings via the inline continuation field
  — only explicitly set attributes take effect; everything else is inherited from
  the parent Continuation.'
from_schema: https://w3id.org/tvbo
attributes:
  source_point:
    name: source_point
    description: 'Which bifurcation point to start from. Syntax: - ''hopf:-1'' = last
      Hopf (default) - ''hopf:all'' = all Hopf points - ''hopf:1'' = first Hopf -
      ''fold:2'' = second fold - integer = specific special point index'
    from_schema: https://w3id.org/tvbo
    alias: source_point
    owner: BranchSwitch
    domain_of:
    - InitialState
    - BranchSwitch
    range: string
  delta_p:
    name: delta_p
    description: Initial parameter offset from the bifurcation point.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: delta_p
    owner: BranchSwitch
    domain_of:
    - BranchSwitch
    range: float
  continuation:
    name: continuation
    description: Override solver settings for this branch. Uses the same Continuation
      type — only explicitly set attributes override the parent's values.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: continuation
    owner: BranchSwitch
    domain_of:
    - BranchSwitch
    range: Continuation
    inlined: true
  discretization:
    name: discretization
    description: Discretization method for the branch solution. Required for periodic
      orbit branches (Hopf → PO). Not needed for codim-2 branches (fold/Hopf continuation).
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: discretization
    owner: BranchSwitch
    domain_of:
    - BranchSwitch
    - PDESolver
    range: Discretization
    inlined: true
  bothside:
    name: bothside
    description: Continue branch in both directions.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: bothside
    owner: BranchSwitch
    domain_of:
    - BranchSwitch
    - Continuation
    range: boolean
  options:
    name: options
    description: Toolkit-specific string options for this branch (linear solver, etc.).
    from_schema: https://w3id.org/tvbo
    alias: options
    owner: BranchSwitch
    domain_of:
    - Discretization
    - BranchSwitch
    - Continuation
    range: Option
    multivalued: true
    inlined: true
  name:
    name: name
    from_schema: https://w3id.org/tvbo
    rank: 1000
    key: true
    alias: name
    owner: BranchSwitch
    domain_of:
    - BrainAtlas
    - CommonCoordinateSpace
    - ParcellationEntity
    - DBSProtocol
    - ClinicalScale
    - ClinicalScore
    - Event
    - Tractogram
    - GraphGenerator
    - File
    - StateValue
    - Observation
    - Dynamics
    - StateVariable
    - Distribution
    - Parameter
    - CouplingInput
    - Argument
    - Function
    - FunctionCall
    - Callable
    - DerivedParameter
    - DerivedVariable
    - DataSource
    - OptimizationStage
    - Exploration
    - UpdateRule
    - Algorithm
    - Option
    - BranchSwitch
    - Continuation
    - Coupling
    - SoftwareEnvironment
    - SoftwareRequirement
    - SoftwarePackage
    range: string
    required: true
  description:
    name: description
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: description
    owner: BranchSwitch
    domain_of:
    - ClinicalScore
    - Equation
    - Stimulus
    - Event
    - Tractogram
    - Matrix
    - Network
    - GraphGenerator
    - File
    - Node
    - Edge
    - Observation
    - Dynamics
    - StateVariable
    - Parameter
    - CouplingInput
    - Argument
    - Function
    - FunctionCall
    - Callable
    - DerivedParameter
    - DerivedVariable
    - RandomStream
    - DataSource
    - OptimizationStage
    - Exploration
    - UpdateRule
    - TuningObjective
    - Algorithm
    - BranchSwitch
    - Continuation
    - Integrator
    - Coupling
    - RegionMapping
    - SimulationExperiment
    - SimulationStudy
    - TimeSeries
    - SoftwareEnvironment
    - SoftwareRequirement
    - SoftwarePackage
    - NDArray
    - SpatialDomain
    - Mesh
    - SpatialField
    - FieldStateVariable
    - BoundaryCondition
    - PDESolver
    - PDE
    range: string
  parameters:
    name: parameters
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: parameters
    owner: BranchSwitch
    domain_of:
    - Equation
    - Stimulus
    - Event
    - TemporalApplicableEquation
    - Network
    - GraphGenerator
    - Node
    - Edge
    - Observation
    - Dynamics
    - Distribution
    - Noise
    - Exploration
    - Discretization
    - BranchSwitch
    - Integrator
    - Coupling
    - PDE
    range: Parameter
    multivalued: true
    inlined: true