Class: FieldStateVariable

URI: tvbo:class/FieldStateVariable

 classDiagram
    class FieldStateVariable
    click FieldStateVariable href "./FieldStateVariable.html"
      StateVariable <|-- FieldStateVariable
        click StateVariable href "./StateVariable.html"
      
      FieldStateVariable : boundaries
        
          
    
        
        
        FieldStateVariable --> "0..1" Range : boundaries
        click Range href "./Range.html"
    

        
      FieldStateVariable : boundary_conditions
        
          
    
        
        
        FieldStateVariable --> "*" BoundaryCondition : boundary_conditions
        click BoundaryCondition href "./BoundaryCondition.html"
    

        
      FieldStateVariable : coupling_variable
        
          
    
        
        
        FieldStateVariable --> "0..1" Boolean : coupling_variable
        click Boolean href "../http://www.w3.org/2001/XMLSchema#boolean.html"
    

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

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

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

        
      FieldStateVariable : distribution
        
          
    
        
        
        FieldStateVariable --> "0..1" Distribution : distribution
        click Distribution href "./Distribution.html"
    

        
      FieldStateVariable : domain
        
          
    
        
        
        FieldStateVariable --> "0..1" Range : domain
        click Range href "./Range.html"
    

        
      FieldStateVariable : equation
        
          
    
        
        
        FieldStateVariable --> "0..1" Equation : equation
        click Equation href "./Equation.html"
    

        
      FieldStateVariable : equation_order
        
          
    
        
        
        FieldStateVariable --> "0..1" Integer : equation_order
        click Integer href "../http://www.w3.org/2001/XMLSchema#integer.html"
    

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

        
      FieldStateVariable : history
        
          
    
        
        
        FieldStateVariable --> "0..1" TimeSeries : history
        click TimeSeries href "./TimeSeries.html"
    

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

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

        
      FieldStateVariable : mesh
        
          
    
        
        
        FieldStateVariable --> "0..1" Mesh : mesh
        click Mesh href "./Mesh.html"
    

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

        
      FieldStateVariable : noise
        
          
    
        
        
        FieldStateVariable --> "0..1" Noise : noise
        click Noise href "./Noise.html"
    

        
      FieldStateVariable : stimulation_variable
        
          
    
        
        
        FieldStateVariable --> "0..1" Boolean : stimulation_variable
        click Boolean href "../http://www.w3.org/2001/XMLSchema#boolean.html"
    

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

        
      FieldStateVariable : unit
        
          
    
        
        
        FieldStateVariable --> "0..1" UnitEnum : unit
        click UnitEnum href "../../enums/UnitEnum.html"
    

        
      FieldStateVariable : variable_of_interest
        
          
    
        
        
        FieldStateVariable --> "0..1" Boolean : variable_of_interest
        click Boolean href "../http://www.w3.org/2001/XMLSchema#boolean.html"
    

        
      

Inheritance

• StateVariable
  • FieldStateVariable

Slots

Name	Cardinality and Range	Description	Inheritance
label	0..1 xsd:string		direct
description	0..1 xsd:string		direct
mesh	0..1 Mesh		direct
boundary_conditions	* BoundaryCondition		direct
name	1 xsd:string		StateVariable
symbol	0..1 xsd:string		StateVariable
definition	0..1 xsd:string		StateVariable
domain	0..1 Range		StateVariable
equation	0..1 Equation		StateVariable
unit	0..1 UnitEnum	Physical unit of measurement	StateVariable
variable_of_interest	0..1 xsd:boolean		StateVariable
coupling_variable	0..1 xsd:boolean	Whether this state variable is transmitted to connected nodes through the cou…	StateVariable
equation_type	0..1 xsd:string	Type of equation: ‘differential’ (default) means dx/dt = rhs, ‘algebraic’ mea…	StateVariable
equation_order	0..1 xsd:integer	Order of the time derivative on the LHS	StateVariable
noise	0..1 Noise		StateVariable
stimulation_variable	0..1 xsd:boolean		StateVariable
boundaries	0..1 Range		StateVariable
initial_value	0..1 xsd:float		StateVariable
derivative_initial_value	0..1 xsd:float	Initial value for the first time derivative, used when equation_order > 1	StateVariable
distribution	0..1 Distribution	Distribution for sampling initial conditions per node	StateVariable
history	0..1 TimeSeries		StateVariable

Usages

used by	used in	type	used
PDE	state_variables	range	FieldStateVariable

Identifier and Mapping Information

Schema Source

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

Mappings

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

LinkML Source

Direct

name: FieldStateVariable
from_schema: https://w3id.org/tvbo
is_a: StateVariable
slots:
- label
- description
attributes:
  mesh:
    name: mesh
    from_schema: https://w3id.org/tvbo
    domain_of:
    - SpatialField
    - FieldStateVariable
    - PDE
    range: Mesh
  boundary_conditions:
    name: boundary_conditions
    from_schema: https://w3id.org/tvbo
    rank: 1000
    domain_of:
    - FieldStateVariable
    - PDE
    range: BoundaryCondition
    multivalued: true

Induced

name: FieldStateVariable
from_schema: https://w3id.org/tvbo
is_a: StateVariable
attributes:
  mesh:
    name: mesh
    from_schema: https://w3id.org/tvbo
    alias: mesh
    owner: FieldStateVariable
    domain_of:
    - SpatialField
    - FieldStateVariable
    - PDE
    range: Mesh
  boundary_conditions:
    name: boundary_conditions
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: boundary_conditions
    owner: FieldStateVariable
    domain_of:
    - FieldStateVariable
    - PDE
    range: BoundaryCondition
    multivalued: true
  label:
    name: label
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: label
    owner: FieldStateVariable
    domain_of:
    - ParcellationTerminology
    - Dataset
    - Contact
    - Equation
    - Stimulus
    - Event
    - Parcellation
    - Tractogram
    - Matrix
    - Network
    - Node
    - Edge
    - Observation
    - Dynamics
    - StateVariable
    - Parameter
    - Function
    - FunctionCall
    - DerivedVariable
    - RandomStream
    - DataSource
    - OptimizationStage
    - Exploration
    - TuningObjective
    - Continuation
    - Coupling
    - RegionMapping
    - SimulationExperiment
    - SimulationStudy
    - TimeSeries
    - SoftwareEnvironment
    - NDArray
    - SpatialDomain
    - Mesh
    - SpatialField
    - FieldStateVariable
    - DifferentialOperator
    - BoundaryCondition
    - PDESolver
    - PDE
    range: string
  description:
    name: description
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: description
    owner: FieldStateVariable
    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
  name:
    name: name
    from_schema: https://w3id.org/tvbo
    rank: 1000
    key: true
    alias: name
    owner: FieldStateVariable
    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
  symbol:
    name: symbol
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: symbol
    owner: FieldStateVariable
    domain_of:
    - StateVariable
    - Parameter
    - DerivedParameter
    - DerivedVariable
    range: string
  definition:
    name: definition
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: definition
    owner: FieldStateVariable
    domain_of:
    - Equation
    - StateVariable
    - Parameter
    - Function
    - DifferentialOperator
    range: string
  domain:
    name: domain
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: domain
    owner: FieldStateVariable
    domain_of:
    - ClinicalScale
    - ClinicalScore
    - StateVariable
    - Distribution
    - Parameter
    - PDE
    range: Range
  equation:
    name: equation
    from_schema: https://w3id.org/tvbo
    rank: 1000
    slot_uri: tvbo:Equation
    alias: equation
    owner: FieldStateVariable
    domain_of:
    - Stimulus
    - Event
    - Observation
    - StateVariable
    - Parameter
    - Function
    - FunctionCall
    - Case
    - DerivedParameter
    - DerivedVariable
    - Noise
    - UpdateRule
    - DifferentialOperator
    range: Equation
    inlined: true
  unit:
    name: unit
    description: Physical unit of measurement. Values are drawn from the QUDT ontology
      (http://qudt.org/vocab/unit/) with UO cross-references where available.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: unit
    owner: FieldStateVariable
    domain_of:
    - CommonCoordinateSpace
    - Edge
    - StateVariable
    - Parameter
    - Argument
    - DerivedParameter
    - DerivedVariable
    - Integrator
    - TimeSeries
    - NDArray
    - SpatialField
    range: UnitEnum
  variable_of_interest:
    name: variable_of_interest
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: 'True'
    alias: variable_of_interest
    owner: FieldStateVariable
    domain_of:
    - StateVariable
    range: boolean
  coupling_variable:
    name: coupling_variable
    description: Whether this state variable is transmitted to connected nodes through
      the coupling function. In TVB terms, this determines the cvar indices (state
      variables extracted from history and fed into the coupling function). The coupling
      function may override this via its incoming_states attribute.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: 'False'
    alias: coupling_variable
    owner: FieldStateVariable
    domain_of:
    - StateVariable
    range: boolean
  equation_type:
    name: equation_type
    description: 'Type of equation: ''differential'' (default) means dx/dt = rhs,
      ''algebraic'' means 0 = rhs or x ~ rhs (DAE constraint). Algebraic equations
      are used by ModelingToolkit.jl backend.'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: string(differential)
    alias: equation_type
    owner: FieldStateVariable
    domain_of:
    - StateVariable
    range: string
  equation_order:
    name: equation_order
    description: Order of the time derivative on the LHS. Default 1 means dx/dt =
      rhs (first-order ODE). Order 2 means d²x/dt² = rhs (second-order ODE), etc.
      Higher-order ODEs are automatically lowered to coupled first-order systems by
      backends like ModelingToolkit.jl via mtkcompile.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: int(1)
    alias: equation_order
    owner: FieldStateVariable
    domain_of:
    - StateVariable
    range: integer
  noise:
    name: noise
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: noise
    owner: FieldStateVariable
    domain_of:
    - StateVariable
    - Integrator
    range: Noise
    inlined: true
  stimulation_variable:
    name: stimulation_variable
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: stimulation_variable
    owner: FieldStateVariable
    domain_of:
    - StateVariable
    range: boolean
  boundaries:
    name: boundaries
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: boundaries
    owner: FieldStateVariable
    domain_of:
    - StateVariable
    range: Range
    inlined: true
  initial_value:
    name: initial_value
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: float(0.1)
    alias: initial_value
    owner: FieldStateVariable
    domain_of:
    - StateVariable
    - SpatialField
    range: float
  derivative_initial_value:
    name: derivative_initial_value
    description: Initial value for the first time derivative, used when equation_order
      > 1. For a second-order ODE d²x/dt² = f, this sets dx/dt(0). Required by ModelingToolkit.jl
      to fully specify higher-order initial value problems.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: derivative_initial_value
    owner: FieldStateVariable
    domain_of:
    - StateVariable
    range: float
  distribution:
    name: distribution
    description: Distribution for sampling initial conditions per node. If present,
      initial_value is used as fallback/mean.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: distribution
    owner: FieldStateVariable
    domain_of:
    - StateVariable
    - Parameter
    - Coupling
    range: Distribution
    inlined: true
  history:
    name: history
    from_schema: https://w3id.org/tvbo
    rank: 1000
    alias: history
    owner: FieldStateVariable
    domain_of:
    - StateVariable
    range: TimeSeries
    inlined: true