Periodicity#
Constraints for periodic motion patterns.
- class biosym.constraints.periodicity.Constraint(model, settings, args)#
Bases:
BaseConstraintBase class for periodicity constraints in the biosym package.
- get_confun()#
Evaluate the dynamics constraint function.
- Parameters:
states_list – Dictionary containing the current states.
- Returns:
The dynamics constraint function.
- get_jacobian()#
Get the Jacobian of the dynamics constraint function.
- Parameters:
states_list – Dictionary containing the current states.
- Returns:
The Jacobian of the dynamics constraint function.
- get_n_constraints()#
Get the number of constraints defined by this dynamics constraint.
- Returns:
The number of constraints.
- get_nnz()#
Get the number of non-zero entries in the Jacobian of the dynamics constraint.
- Returns:
The number of non-zero entries.
- biosym.constraints.periodicity.confun(states_list, _, dims, id_symmetry)#
Evaluate the constraint function for adaptive step sizes. :param states_list: Dictionary containing the current states. :param globals_dict: Dictionary containing global variables (e.g., duration). :param settings: Dictionary containing settings for the dynamics constraint. :param info: Information about the constraint function. :return: The evaluated constraint function.
- biosym.constraints.periodicity.get_symmetry_indices(model)#
- biosym.constraints.periodicity.jacobian_per(states_list, _, dims, id_symmetry, nnodes_dur, settings)#
Placeholder for the Jacobian of the constraint function.
This function should be implemented in subclasses to compute the Jacobian of the dynamics constraints.
- Parameters:
states_list – List containing the current states.
settings – Dictionary containing settings for the dynamics constraint.
info – Information about the constraint function.
- Returns:
The Jacobian of the constraint function.