SBInteractionModel

This class describes the base class for interaction models.

Interaction models compute interactions for a dynamical model, for example forces that are then consumed by a simulator and its state updater.

See also

samson.SBDynamicalModel

samson.SBSimulator

SAMSON SDK: SBMInteractionModel

class samson.SBInteractionModel(self: samson.SBInteractionModel)

Bases: SBModel

Base class for interaction models.

Interaction models compute interactions, energies, and force updates that can be consumed by simulators and state updaters.

Constructs an interaction model.

flushForceBuffer(self: samson.SBInteractionModel) → None

Flushes the force buffer.

getChangedForceIndex(self: samson.SBInteractionModel, i: int) → int

Returns the index of the i-th changed force.

getForceChanged(self: samson.SBInteractionModel, i: int) → bool

Returns True if force i changed since last flush.

getSimulatorList(self: samson.SBInteractionModel) → samson.SBNodeIndexer

Returns simulators associated with this interaction model.

initializeInteractions(self: samson.SBInteractionModel) → None

Initializes interactions.

updateInteractions(self: samson.SBInteractionModel) → None

Updates interactions.

property energy

Current interaction energy.

property interactionModelType

Interaction-model type.

property numberOfChangedForces

Number of changed forces since last flush.