Skip to content

DriftRecorder

DriftRecorder

DriftRecorder(**kwargs)

Bases: Recorder

Recorder for inter-story drift ratios.

DriftRecorder captures inter-story drift ratios between pairs of nodes (such as story bottoms and tops) to monitor shear deformation and relative structural movements.

Tcl form

recorder Drift -file <fileName> -iNode <iNodeTags...> -jNode <jNodeTags...> -dof <dof> -perpDirn <perpDirn>

Note
  • In parallel MPI runs, this recorder automatically injects $pid into the output filename (before the extension) to prevent file conflicts.
Example
from femora.core.model import Model

model = Model()
# Record inter-story drift between node 1 and 101 along DOF 1
recorder = model.recorder.drift(
    file_name="StoryDrift.out",
    i_nodes=[1],
    j_nodes=[101],
    dof=1,
    perp_dirn=3,
    time=True,
)

Create a drift recorder.

Parameters:

Name Type Description Default
**kwargs

Key-value parameters: file_name: Output file name (required). i_nodes: List of bottom node tags (required). j_nodes: List of top node tags (required). dof: Target degree of freedom (1 to 6). perp_dirn: Perpendicular direction (1 to 3). time: If True, records simulation time. delta_t: Optional time step recording interval. precision: Optional number of significant digits. cores: Optional processor core ID(s) for MPI execution.

{}

Raises:

Type Description
ValueError

If input validation fails.

TypeError

If cores or node lists are invalid types.