MEDYAN.jl
  • Home
  • Tutorials
  • How-To
  • Explanations
  • Reference
  • Versions
    • dev
    • stable

On this page

  • MEDYAN.update_link!
    • Tuple{MEDYAN.Context, MEDYAN.Link}
  • Edit this page
  • Report an issue

MEDYAN.update_link!

Tuple{MEDYAN.Context, MEDYAN.Link}

update_link!(c::Context, link::Link; kwargs...)::Nothing

Update the link.

Keyword Arguments

  • places=(): places or tags to attach to the link.

    Set an element to nothing not change the attached place. Set an element to a null place or tag to detach that place.

  • state=(;): state properties to change.

    A NamedTuple of changes. For example, state = (;k1 = 3.6, k7 = 2.0,) to change state.k1 to 3.6 and state.k7 to 2.0.

  • bond_states=(): bond state properties to change.

    A Tuple of changes. If an element in the tuple is nothing, the corresponding bond state isn’t changed. For example, bond_states = (nothing, (;L0 = 3.6,)) to change bond_states[2].L0 to 3.6.

  • bond_enabled=(): bond enable flags to change.

    A Tuple of Union{Bool, Nothing}. If an element in the tuple isnothing, the corresponding bond enable flag isn't changed. For example,bond_enabled = (nothing, true, false)` to not change bond 1, enable bond 2, and disable bond 3.

  • reaction_enabled=(): reaction enable flags to change.

    A Tuple of Tuple of Union{Bool, Nothing}. If an element in the tuple isnothing, the corresponding reaction enable flag or flags aren't changed. For example,reaction_enabled = (nothing, (true, nothing, false))` to not change any reactions on place 1, enable reaction 1 on place 2, and disable reaction 3 on place 2.

  • is_minimized::Bool=false: is the link marked as minimized.

    By default links are marked as minimized at the end of mechanics when updated.

  • Edit this page
  • Report an issue