function

RigidBody.mechanicalEnergy

Rigid-body mechanical storage function

Public declarations

Explicit source declarations; dimensions, modifications and defaults are shown as written, without evaluation.

Role	Name	Type
input	`state`	`RigidBody.State`
input	`parameters`	`RigidBody.Parameters`
output	`energy`	`Real`

Modelica declarations and implementation

Show parameters, interfaces and source

Parameters, inputs, outputs, defaults and equations from the source file.

function mechanicalEnergy "Rigid-body mechanical storage function"
  input RigidBody.State state;
  input RigidBody.Parameters parameters;
  output Real energy;
algorithm
  energy := RigidBody.kineticEnergy(state, parameters)
    + RigidBody.potentialEnergy(state, parameters);
end mechanicalEnergy;