symbrim.rider.rider.Rider

class symbrim.rider.rider.Rider(name: str)

Bases: ModelBase

Customizable rider mode.

Attributes

auxiliary_handler	Auxiliary data handler of the model.
connections	Submodels out of which this model exists.
convention
descriptions	Descriptions of the attributes of the object.
left_arm	Left arm of the rider.
left_hip	Connection between the pelvis and the left leg.
left_leg	Left leg of the rider.
left_shoulder	Connection between the torso and the left arm.
load_groups	Load groups of the connection.
name	Name of the object.
pelvis	Pelvis of the rider.
required_connections
required_models
right_arm	Right arm of the rider.
right_hip	Connection between the pelvis and the right leg.
right_leg	Right leg of the rider.
right_shoulder	Connection between the torso and the right arm.
sacrum	Connection between the pelvis and the torso.
submodels	Submodels out of which this model exists.
system	System object used to store the information of the model itself.
torso	Torso of the rider.

Methods

__init__	Create a new instance of the model.
add_load_groups	Add load groups to the connection.
define_all	Define all aspects of the model.
define_connections	Define the submodels used by connections in the model.
define_constraints	Define the constraints on the model.
define_kinematics	Establish the kinematics of the objects belonging to the model.
define_loads	Define the loads that are acting upon the model.
define_objects	Initialize the objects belonging to the model.
from_convention	Create a model from a convention.
get_all_symbols	Get all declared symbols of a model.
get_description	Get description of a given object.
get_param_values	Get a parameters mapping of a model based on a bicycle parameters object.
set_plot_objects	Set the symmeplot plot objects.
to_system	Export the model to a single system instance.

__init__(name: str) → None

Create a new instance of the model.

Parameters:

name (str) – Name of the model.

__repr__() → str

Return repr(self).

__str__() → str

Return str(self).

__weakref__

list of weak references to the object (if defined)

add_load_groups(*load_groups: LoadGroupBase) → None

Add load groups to the connection.

property auxiliary_handler: AuxiliaryDataHandler | None

Auxiliary data handler of the model.

property connections: tuple[ConnectionBase]

Submodels out of which this model exists.

define_all() → None

Define all aspects of the model.

define_connections() → None

Define the submodels used by connections in the model.

define_constraints() → None

Define the constraints on the model.

define_kinematics() → None

Establish the kinematics of the objects belonging to the model.

define_loads() → None

Define the loads that are acting upon the model.

define_objects() → None

Initialize the objects belonging to the model.

property descriptions: dict[object, str]

Descriptions of the attributes of the object.

classmethod from_convention(convention: str, name: str, *args: object, **kwargs: dict[str, object]) → ModelBase

Create a model from a convention.

get_all_symbols() → set[Basic]

Get all declared symbols of a model.

get_description(obj: object) → str | None

Get description of a given object.

get_param_values(bicycle_parameters: Bicycle) → dict[Symbol, float]

Get a parameters mapping of a model based on a bicycle parameters object.

property left_arm: LeftArmBase

Left arm of the rider.

property left_hip: LeftHipBase

Connection between the pelvis and the left leg.

property left_leg: LeftLegBase

Left leg of the rider.

property left_shoulder: LeftShoulderBase

Connection between the torso and the left arm.

property load_groups: tuple[LoadGroupBase]

Load groups of the connection.

property name: str

Name of the object.

property pelvis: PelvisBase

Pelvis of the rider.

property right_arm: RightArmBase

Right arm of the rider.

property right_hip: RightHipBase

Connection between the pelvis and the right leg.

property right_leg: RightLegBase

Right leg of the rider.

property right_shoulder: RightShoulderBase

Connection between the torso and the right arm.

property sacrum: SacrumBase

Connection between the pelvis and the torso.

set_plot_objects(plot_object: MplPlotBase) → None

Set the symmeplot plot objects.

property submodels: tuple[ModelBase]

Submodels out of which this model exists.

property system: System | None

System object used to store the information of the model itself.

Notes

This system object is used to store the information of the model itself. It does not by definition contain any information about the submodels or connections. Therefore, one cannot use this system object to form the equations of motion. Instead, one should use the to_system() method to get the system object representing the entire model.

to_system() → System

Export the model to a single system instance.

property torso: TorsoBase

Torso of the rider.