brim.core.base_classes.BrimBase

class brim.core.base_classes.BrimBase(name: str)

Bases: object

Base class defining a common interface for the models and connections.

Attributes

auxiliary_handler	Auxiliary data handler of the model.
descriptions	Descriptions of the attributes of the object.
name	Name of the object.
system	System object used to store the information of the model itself.

Methods

__init__	Create a new instance.
define_constraints	Define the constraints of the system.
define_kinematics	Define the kinematics of the system.
define_loads	Define the loads of the system.
define_objects	Define the objects of the system.
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.

__init__(name: str) → None

Create a new instance.

Parameters:

name (str) – Name of the object.

__repr__() → str

Return repr(self).

__str__() → str

Return str(self).

__weakref__

list of weak references to the object (if defined)

property auxiliary_handler: AuxiliaryDataHandler | None

Auxiliary data handler of the model.

define_constraints() → None

Define the constraints of the system.

define_kinematics() → None

Define the kinematics of the system.

define_loads() → None

Define the loads of the system.

define_objects() → None

Define the objects of the system.

property descriptions: dict[Any, str]

Descriptions of the attributes of the object.

get_all_symbols() → set[sympy.core.basic.Basic]

Get all declared symbols of a model.

get_description(obj: Any) → str

Get description of a given object.

get_param_values(bicycle_parameters: Bicycle) → dict[sympy.core.symbol.Symbol, float]

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

property name: str

Name of the object.

set_plot_objects(plot_object: MplPlotBase) → None

Set the symmeplot plot objects.

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.