Skip to content

docs: transient_options.md references engine.adaptive_config which doesn't exist on CircuitEngine #105

@github-actions

Description

@github-actions

Problem

transient_options.md contains two incorrect references to engine.adaptive_config — an attribute that does not exist on CircuitEngine.

Line 42 (comment, misleading):

engine.prepare(use_sparse=True)
# engine.adaptive_config.lte_ratio == 1.5  (from tran_lteratio)

Lines 175-177 (broken assertions that would raise AttributeError):

engine.prepare(use_sparse=True)
assert engine.adaptive_config.lte_ratio == 1.5
assert engine.adaptive_config.nr_convtol == 1.0

Root Cause

CircuitEngine stores simulation options in engine.options (a SimulationOptions instance), not in an adaptive_config attribute. After prepare() is called, the netlist tran_lteratio option is stored in engine.options.tran_lteratio (not lte_ratio), and nr_convtol is in engine.options.nr_convtol.

Correct assertions would be:

engine.prepare(use_sparse=True)
assert engine.options.tran_lteratio == 1.5
assert engine.options.nr_convtol == 1.0

Verified

>>> from vajax import CircuitEngine
>>> hasattr(CircuitEngine, 'adaptive_config')
False  # attribute does not exist

File: docs/transient_options.md, lines 42, 175-177

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation issues

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions