Skip to content

BeamForceRecorder

BeamForceRecorder

BeamForceRecorder(**kwargs)

Bases: Recorder

Specialized Element force recorder for line meshes.

BeamForceRecorder automatically resolves the element tags associated with selected line mesh parts and creates parallel Element force recorders grouped by MPI compute core.

Tcl form

Generates parallel recorder Element commands guarded by $pid == <core>.

Example
from femora.core.model import Model

model = Model()
# Record beam local forces for two line meshparts
recorder = model.recorder.beam_force(
    meshparts=["Beam1", "Beam2"],
    force_type="localForce",
    file_prefix="BeamForces",
)

Create a beam force recorder.

Parameters:

Name Type Description Default
**kwargs

Key-value parameters: meshparts: Optional list of MeshPart identifiers (user_name strings or MeshPart instances). If omitted, all line mesh parts are used. force_type: Force system, either 'globalForce' or 'localForce'. file_prefix: Prefix for output files (default: 'Beam'). delta_t: Optional time step recording interval. include_time: If True, includes time in columns (default: True). output_format: Output format, either 'file', 'xml', or 'binary'. precision: Optional significant digits.

{}

Raises:

Type Description
ValueError

If force_type or output_format are invalid.