Procedures

ProcedureLocationProcedure TypeDescription
abs dynamics_quaternions Interface
acceleration_transform dynamics_rotation Function

Computes the acceleration transformation matrix relating the position of a point expressed in a rotating and translating body relative to its parent frame.

Read more…
aimag dynamics_quaternions Interface
apply_boundary_conditions dynamics_structural Interface
apply_displacement_constraint dynamics_structural Interface
assemble_damping_matrix dynamics_discrete_elements Interface
assemble_discrete_system dynamics_discrete_elements Interface
assemble_dynamic_system dynamics_structural Interface
assemble_static_system dynamics_structural Interface
assignment(=) dynamics_quaternions Interface
assignment(=) dynamics_geometry Interface
beam_element_2d dynamics_beam_elements Interface
beam_element_3d dynamics_beam_elements Interface
binary_link dynamics_linkage Interface
chirp dynamics_frequency_sweep Function

Evaluates a linear chirp function. The instantaneous frequency varies linearly, giving phase and response .

compute_modal_damping dynamics_modal_analysis Function

Computes the modal damping factors given the proportional damping terms and where , , and is the eigenvalue of the system. Equivalently, .

conjg dynamics_quaternions Interface
constraint_equations dynamics_system_id Interface
coordinate_system dynamics_kinematics Interface
create_connectivity_matrix dynamics_structural Function

Creates a connectivity matrix for the element, stored in CSR format. The matrix contains exactly one non-zero (unity) entry per row; therefore, it is well-suited to a sparse representation.

cross_product dynamics_helper Function

Computes the cross-product of two three-dimensional vectors. The result is orthogonal to both inputs and is defined by

damper_element_2d dynamics_discrete_elements Interface
damper_element_3d dynamics_discrete_elements Interface
damping_from_fractional_overshoot dynamics_vibrations Function

Employs the method of fractional overshoot to estimate the damping ratio from the response of a system to a step input. This method is useful for cases where the damping ratio is between approximately 0.5 to 0.8. In such range, the logarithmic decrement approach becomes less precise.

Read more…
damping_from_log_decrement dynamics_vibrations Function

Computes the damping ratio from the logarithmic decrement . The damping ratio is related to the logarithmic decrement by the following relationship.

Read more…
determine_local_stability dynamics_stability Function

Determines the nature of stability/unstability near the point at which the dynamics matrix was computed.

Read more…
dh_forward_kinematics dynamics_kinematics Interface
dh_jacobian dynamics_kinematics Interface
dh_matrix dynamics_kinematics Function

Computes the Denavit-Hartenberg transformation matrix for the specified DH parameters.

Read more…
dh_parameter_set dynamics_kinematics Interface
dh_rotate_x dynamics_kinematics Function

Computes the Denavit-Hartenberg matrix for a local x-axis rotation.

dh_rotate_z dynamics_kinematics Function

Computes the Denavit-Hartenberg matrix for a local z-axis rotation.

dh_table dynamics_kinematics Interface
dh_translate_x dynamics_kinematics Function

Computes the Denavit-Hartenberg matrix for a local x-axis translation.

dh_translate_z dynamics_kinematics Function

Computes the Denavit-Hartenberg matrix for a local z-axis translation.

do_lines_intersect dynamics_geometry Subroutine

Tests to see if two lines intersect.

dot_product dynamics_quaternions Interface
dynamic_stiffness dynamics_frequency_response Interface
estimate_bandwidth dynamics_vibrations Function

Estimates the bandwidth of the resonant mode of a vibratory system. The bandwidth is the width of the range of frequencies for which the energy is at least half its peak value and is computed as . Combining this relation with gives

evaluate_accelerance_frf_model dynamics_frequency_response Interface
evaluate_receptance_frf_model dynamics_frequency_response Interface
evaluate_step_response dynamics_vibrations Function

Evaluates the response of an underdamped single-degree-of-freedom, linear system to a step function of amplitude .

Read more…
exp dynamics_quaternions Interface
find_free_response_properties dynamics_vibrations Subroutine

Given a free-response time history, this routine attempts to find the logarithmic decrement and resonant frequency of a vibratory system. The logarithmic decrement is estimated by finding successive peaks by means of peak detection. If peaks are separated by cycles, the damped frequency estimate is

find_settling_amplitude dynamics_vibrations Function

Estimates the settling amplitude for a step response. The final-value estimate is the zero-frequency Fourier coefficient,

fit_frf dynamics_frequency_response Function

Fits an experimentally obtained frequency response by model for either a receptance model:

Read more…
frequency_response dynamics_frequency_response Interface

Computes the frequency response functions for a system of ODE's.

frequency_sweep dynamics_frequency_sweep Interface
harmonic_ode dynamics_frequency_sweep Interface
homogeneous_rotation_x dynamics_rotation Function

Constructs the 4-by-4 homogeneous transformation matrix describing a rotation about an x-axis.

Read more…
homogeneous_rotation_y dynamics_rotation Function

Constructs the 4-by-4 homogeneous transformation matrix describing a rotation about a y-axis.

Read more…
homogeneous_rotation_z dynamics_rotation Function

Constructs the 4-by-4 homogeneous transformation matrix describing a rotation about a y-axis.

Read more…
initialize_rigid_body dynamics_rigid_bodies Subroutine

Initializes a rigid_body object.

initialize_variational_state dynamics_variational_integrators Subroutine

Allocates and initializes a maximal-coordinate state. Positions and velocities are set to zero, and every orientation is set to the identity quaternion.

inverse dynamics_quaternions Function

Computes the inverse of a quaternion. For a nonzero quaternion,

is_parallel dynamics_geometry Interface
is_point_on_line dynamics_geometry Function

Tests to see if a point lies on a line.

is_point_on_plane dynamics_geometry Function

Tests to see if a point lies on a plane.

is_symmetric dynamics_helper Function

Tests to see if a matrix is symmetric.

jacobian_generating_vector dynamics_kinematics Function

Computes a single Jacobian generating vector given the position vector of the link origin, , and the joint axis unit vector, .

Read more…
joint dynamics_joints Interface
joint_degrees_of_freedom dynamics_joints Function

Gets the number of degrees of freedom permitted by the requested joint type.

line dynamics_geometry Interface
line_common_normal dynamics_geometry Function

Returns the common normal line between two lines pointing from ln1 to ln2. In the event that the two lines are parallel within the specified tolerance, there exist an infinite number of common normals; therefore, a line will be chosen that runs from ln1 to ln2 with the point at t = 0 coincident with the point at t = 0 on ln1.

line_from_point_and_vector dynamics_geometry Function

Constructs a new line from a point (defines the point where t = 0) and a direction vector.

linkage_dynamic_model dynamics_linkage_dynamics Interface
log dynamics_quaternions Interface
logarithmic_decrement dynamics_vibrations Function

Computes the logarithmic decrement given the value of two successive peaks in the time history of the free vibratory response of the system. The logarithmic decrement is calculated as follows.

Read more…
lti_solve dynamics_controls Function

Solves the LTI system given by the specified state space model.

mass_element_2d dynamics_discrete_elements Interface
mass_element_3d dynamics_discrete_elements Interface
material dynamics_structural Interface
matmul dynamics_geometry Interface
modal_excite dynamics_frequency_response Interface
modal_response dynamics_modal_analysis Interface
multi_joint_link dynamics_linkage Interface
nearest_point_on_line dynamics_geometry Function

Gets the line parameter for the point on the line nearest the specified point.

nodally_averaged_strain dynamics_structural Function

Computes nodal strain results by averaging the strain contributions from each element incident upon a node.

nodally_averaged_stress dynamics_structural Function

Computes nodal stress results by averaging the stress contributions from each element incident upon a node.

node dynamics_structural Interface
normal_vector_to_line dynamics_geometry Function

Computes the normal vector to a line defined by pt1 and pt2 assuming some point (pt) not on the line.

normalize_mode_shapes dynamics_modal_analysis Subroutine

Normalizes mode shape vectors such that the largest magnitude value in the vector is one. For each column , the operation is

ode_excite dynamics_frequency_sweep Interface
operator(*) dynamics_quaternions Interface
operator(*) dynamics_controls Interface
operator(**) dynamics_quaternions Interface
operator(+) dynamics_quaternions Interface
operator(-) dynamics_quaternions Interface
operator(/) dynamics_quaternions Interface
parallel_linkage dynamics_parallel_linkage Interface
planar_linkage dynamics_parallel_linkage Interface
plane dynamics_geometry Interface
plane_normal dynamics_geometry Function

Returns the normal vector of a plane.

plucker_line dynamics_geometry Interface
poincare_map dynamics_maps Interface
point dynamics_geometry Interface
point_plane_projection dynamics_geometry Function

Projects a point onto a plane.

point_to_line_distance dynamics_geometry Function

Computes the shortest distance between a point and a line.

point_to_plane_distance dynamics_geometry Function

Computes the shortest distance between a point and a plane.

q_factor dynamics_vibrations Function

Estimates the Q-factor for a vibratory system. The Q-factor is computed . For a lightly damped mode, is also approximately the ratio of the resonant frequency to its half-power bandwidth.

quaternion dynamics_quaternions Interface
real dynamics_quaternions Interface
rectangular_shell_element dynamics_shell_elements Interface
restore_constrained_values dynamics_structural Interface
rigid_body dynamics_rigid_bodies Interface
rise_time dynamics_vibrations Function

Computes the rise time for an underdamped, second-order system. The rise time is the time it takes for the system response to go from 0% to 100% of its final value and is given by the following relationship.

Read more…
rotate dynamics_rotation Interface
rotate_x dynamics_rotation Function

Constructs the rotation matrix describing a rotation about an x-axis such that .

Read more…
rotate_y dynamics_rotation Function

Constructs the rotation matrix describing a rotation about a y-axis such that .

Read more…
rotate_z dynamics_rotation Function

Constructs the rotation matrix describing a rotation about a y-axis such that .

Read more…
scalar_projection dynamics_helper Function

Computes the projection of vector x onto vector y. The scalar projection is defined such that

serial_linkage dynamics_linkage Interface
shape_function_derivative dynamics_structural Function

Computes the derivative of the shape function with respect to the natural coordinate specified. The derivative is approximated centrally as The second derivative uses the centered finite difference

shape_function_second_derivative dynamics_structural Function

Computes the second derivative of the shape function with respect to the natural coordinate specified.

siso_model_fit_least_squares dynamics_system_id Interface
solve_inverse_kinematics dynamics_kinematics Function

Solves the inverse kinematics problem for a linkage. An iterative solution procedure is utilized.

solve_static_system dynamics_structural Interface
spring_element_2d dynamics_discrete_elements Interface
spring_element_3d dynamics_discrete_elements Interface
ss_excitation dynamics_controls Interface
state_space dynamics_controls Interface
to_angle_axis dynamics_rotation Subroutine

Extracts the equivalent rotation angle and axis of rotation given a 3-by-3 rotation matrix. For a proper rotation, the angle is recovered from while the skew-symmetric part satisfies

to_skew_symmetric dynamics_helper Function

Converts a 3-element vector to a 3-by-3 skew-symmetric matrix. A skew-symmetric matrix is defined as follows.

Read more…
transfer_function dynamics_controls Interface
transform_inverse dynamics_kinematics Function

Computes the inverse of a 4-by-4 homogeneous transformation matrix.

Read more…
translate dynamics_rotation Interface
triangular_shell_element dynamics_shell_elements Interface
truss_element_2d dynamics_truss_elements Interface
truss_element_3d dynamics_truss_elements Interface
vector_angle dynamics_helper Function

Computes the unsigned angle between two nonzero vectors.

vector_plane_projection dynamics_geometry Function

Projects a vector onto a plane.

vector_projection dynamics_helper Function

Computes the vector projection of vector x onto vector y. The vector projection is defined such that ( proj_{y} \vec{x} =

velocity_transform dynamics_rotation Function

Computes the velocity transformation matrix relating the position of a point expressed in a rotating and translating body relative to its parent frame.

Read more…