Skip to content

Commit

Permalink
docs: add translational components in the API section
Browse files Browse the repository at this point in the history
  • Loading branch information
sathvikbhagavan committed Feb 2, 2024
1 parent 2029edb commit 9797293
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions docs/src/API/mechanical.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,40 @@ SpeedSensor
TorqueSensor
RelSpeedSensor
```

## Translational Components

```@meta
CurrentModule = ModelingToolkitStandardLibrary.Mechanical.Translational
```

### Translational Utils

```@docs
MechanicalPort
```

### Translational Core Components

```@docs
Mass
Spring
Damper
Fixed
```

### Translational Sources

```@docs
Force
Position
Velocity
Acceleration
```

### Translational Sensors

```@docs
ForceSensor
PositionSensor
```

0 comments on commit 9797293

Please sign in to comment.