Class: FieldStateVariable

URI: tvbo:FieldStateVariable

 classDiagram
    class FieldStateVariable
    click FieldStateVariable href "./FieldStateVariable.html"
      StateVariable <|-- FieldStateVariable
        click StateVariable href "./StateVariable.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 : grounding
        
          
    
        
        
        FieldStateVariable --> "*" Uriorcurie : grounding
        click Uriorcurie href "../http://www.w3.org/2001/XMLSchema#anyURI.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 : record
        
          
    
        
        
        FieldStateVariable --> "0..1" Boolean : record
        click Boolean href "../http://www.w3.org/2001/XMLSchema#boolean.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

Class Properties

Property Value
Class URI tvbo: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		 Globally unique identifier for the entity 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
record 0..1
xsd:boolean		 Whether to include this element in simulation output files StateVariable
grounding *
xsd:anyURI		 External ontology IRIs (typically GO, ChEBI, UBERON, CL, MeSH) that this enti… 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
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:
    - Network
    - 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
class_uri: tvbo:FieldStateVariable

Induced

name: FieldStateVariable
from_schema: https://w3id.org/tvbo
is_a: StateVariable
attributes:
  mesh:
    name: mesh
    from_schema: https://w3id.org/tvbo
    owner: FieldStateVariable
    domain_of:
    - Network
    - SpatialField
    - FieldStateVariable
    - PDE
    range: Mesh
  boundary_conditions:
    name: boundary_conditions
    from_schema: https://w3id.org/tvbo
    rank: 1000
    owner: FieldStateVariable
    domain_of:
    - FieldStateVariable
    - PDE
    range: BoundaryCondition
    multivalued: true
  label:
    name: label
    from_schema: https://w3id.org/tvbo
    rank: 1000
    slot_uri: rdfs:label
    owner: FieldStateVariable
    domain_of:
    - ParcellationTerminology
    - Subject
    - Session
    - Dataset
    - Contact
    - SoftwareEnvironment
    - Equation
    - Stimulus
    - Event
    - Parcellation
    - Tractogram
    - Matrix
    - Phenotype
    - Network
    - Node
    - Edge
    - Observation
    - Dynamics
    - StateVariable
    - Parameter
    - Function
    - FunctionCall
    - DerivedVariable
    - RandomStream
    - DataSource
    - OptimizationStage
    - Exploration
    - ExplorationAxis
    - FreeParameter
    - Inference
    - AlgorithmStage
    - TuningObjective
    - Continuation
    - Coupling
    - RegionMapping
    - SimulationExperiment
    - SimulationStudy
    - TimeSeries
    - NDArray
    - SpatialDomain
    - Mesh
    - SpatialField
    - FieldStateVariable
    - DifferentialOperator
    - BoundaryCondition
    - PDESolver
    - PDE
    range: string
  description:
    name: description
    from_schema: https://w3id.org/tvbo
    rank: 1000
    slot_uri: dcterms:description
    owner: FieldStateVariable
    domain_of:
    - Dataset
    - ClinicalScore
    - SoftwarePackage
    - SoftwareRequirement
    - SoftwareEnvironment
    - Equation
    - Stimulus
    - Event
    - Tractogram
    - Matrix
    - Phenotype
    - MeasureSpec
    - NamedArray
    - Network
    - GraphGenerator
    - ProcedureStep
    - File
    - Node
    - Edge
    - Observation
    - Dynamics
    - StateVariable
    - Parameter
    - CouplingInput
    - Argument
    - Function
    - FunctionCall
    - Callable
    - DerivedParameter
    - DerivedVariable
    - RandomStream
    - DataSource
    - OptimizationStage
    - Exploration
    - ExplorationAxis
    - FreeParameter
    - Inference
    - Prior
    - Likelihood
    - UpdateRule
    - AlgorithmStage
    - TuningObjective
    - Algorithm
    - BranchSwitch
    - Continuation
    - Integrator
    - Coupling
    - RegionMapping
    - SimulationExperiment
    - Study
    - TimeSeries
    - NDArray
    - SpatialDomain
    - Mesh
    - SpatialField
    - FieldStateVariable
    - BoundaryCondition
    - PDESolver
    - PDE
    range: string
  name:
    name: name
    description: Globally unique identifier for the entity.
    from_schema: https://w3id.org/tvbo/common
    slot_uri: schema:name
    identifier: true
    owner: FieldStateVariable
    domain_of:
    - BrainAtlas
    - CommonCoordinateSpace
    - ParcellationEntity
    - DBSProtocol
    - ClinicalScale
    - ClinicalScore
    - SoftwarePackage
    - SoftwareRequirement
    - SoftwareEnvironment
    - Event
    - Tractogram
    - MeasureSpec
    - NamedArray
    - GraphGenerator
    - Binding
    - ProcedureStep
    - File
    - StateValue
    - Observation
    - Dynamics
    - StateVariable
    - Distribution
    - Parameter
    - CouplingInput
    - Argument
    - Function
    - FunctionCall
    - Callable
    - DerivedParameter
    - DerivedVariable
    - DataSource
    - OptimizationStage
    - Exploration
    - Inference
    - Prior
    - Likelihood
    - UpdateRule
    - Algorithm
    - Option
    - BranchSwitch
    - Continuation
    - Coupling
    range: string
    required: true
  symbol:
    name: symbol
    from_schema: https://w3id.org/tvbo
    rank: 1000
    owner: FieldStateVariable
    domain_of:
    - StateVariable
    - Parameter
    - DerivedParameter
    - DerivedVariable
    range: string
  definition:
    name: definition
    from_schema: https://w3id.org/tvbo
    rank: 1000
    slot_uri: skos:definition
    owner: FieldStateVariable
    domain_of:
    - Equation
    - StateVariable
    - Parameter
    - Function
    - DifferentialOperator
    range: string
  domain:
    name: domain
    from_schema: https://w3id.org/tvbo
    aliases:
    - range
    - boundaries
    rank: 1000
    owner: FieldStateVariable
    domain_of:
    - ClinicalScale
    - ClinicalScore
    - StateVariable
    - Distribution
    - Parameter
    - ExplorationAxis
    - FreeParameter
    - PDE
    range: Range
  equation:
    name: equation
    from_schema: https://w3id.org/tvbo
    rank: 1000
    slot_uri: tvbo:Equation
    owner: FieldStateVariable
    domain_of:
    - Stimulus
    - Event
    - ProcedureStep
    - 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
    slot_uri: qudt:unit
    owner: FieldStateVariable
    domain_of:
    - CommonCoordinateSpace
    - MeasureSpec
    - NamedArray
    - Edge
    - StateVariable
    - Parameter
    - Argument
    - DerivedParameter
    - DerivedVariable
    - ExplorationAxis
    - Integrator
    - TimeSeries
    - NDArray
    - SpatialField
    range: UnitEnum
  record:
    name: record
    description: Whether to include this element in simulation output files. Applicable
      to state variables (default true), derived variables (default false), and network
      nodes (default true). Set false to suppress recording.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: 'True'
    owner: FieldStateVariable
    domain_of:
    - Node
    - StateVariable
    - DerivedVariable
    - Exploration
    range: boolean
  grounding:
    name: grounding
    description: 'External ontology IRIs (typically GO, ChEBI, UBERON, CL, MeSH) that
      this entity is a surrogate / abstraction / model of. Replaces the legacy OWL
      pattern `tvbo:surrogate_of` by carrying the link inline with the YAML data instance.
      Multiple IRIs allowed: a single parameter may abstract several biological processes
      (e.g. a synaptic conductance grounding both GO:0060079 (excitatory PSP) and
      GO:0007268 (chemical synaptic transmission)).'
    from_schema: https://w3id.org/tvbo
    rank: 1000
    slot_uri: oboInOwl:hasDbXref
    owner: FieldStateVariable
    domain_of:
    - StateVariable
    - Parameter
    - DerivedVariable
    range: uriorcurie
    multivalued: true
  variable_of_interest:
    name: variable_of_interest
    deprecated: Use 'record' instead. A state variable is recorded in the output when
      record=true (the default); set record=false to suppress it. 'variable_of_interest'
      is retained for backward compatibility and is ignored by the TVB/jax/rateml
      codegen.
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: 'True'
    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'
    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)
    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)
    owner: FieldStateVariable
    domain_of:
    - StateVariable
    range: integer
  noise:
    name: noise
    from_schema: https://w3id.org/tvbo
    owner: FieldStateVariable
    domain_of:
    - Stimulus
    - StateVariable
    - Integrator
    range: Noise
    inlined: true
  stimulation_variable:
    name: stimulation_variable
    from_schema: https://w3id.org/tvbo
    rank: 1000
    owner: FieldStateVariable
    domain_of:
    - StateVariable
    range: boolean
  initial_value:
    name: initial_value
    from_schema: https://w3id.org/tvbo
    rank: 1000
    ifabsent: float(0.1)
    owner: FieldStateVariable
    domain_of:
    - StateVariable
    - FreeParameter
    - 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
    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
    owner: FieldStateVariable
    domain_of:
    - StateVariable
    - Parameter
    - Noise
    - Prior
    - Coupling
    range: Distribution
    inlined: true
  history:
    name: history
    from_schema: https://w3id.org/tvbo
    rank: 1000
    owner: FieldStateVariable
    domain_of:
    - StateVariable
    range: TimeSeries
    inlined: true
class_uri: tvbo:FieldStateVariable