The rlc Reference Manual

Next: , Previous: , Up: (dir)   [Contents][Index]

The rlc Reference Manual

This is the rlc Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 05:46:40 2022 GMT+0.

Table of Contents


1 Introduction

This library provides simulation for RLC (resistance, inductance,
capacitance) circuits. Cases are provides for null (0 value)
resistors, inductors, and capacitors.

Rather than using iterative differential equation simulators, this
programs uses analytic solutions derived using Laplace
transformations.





2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 rlc

Dependency

kmrcl (system).

Source

rlc.asd.

Child Components

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp   [Contents][Index]

3.1.1 rlc/rlc.asd

Source

rlc.asd.

Parent Component

rlc (system).

ASDF Systems

rlc.

Packages

rlc-system.


Next: , Previous: , Up: Lisp   [Contents][Index]

3.1.2 rlc/package.lisp

Source

rlc.asd.

Parent Component

rlc (system).

Packages

rlc.


Previous: , Up: Lisp   [Contents][Index]

3.1.3 rlc/main.lisp

Dependency

package.lisp (file).

Source

rlc.asd.

Parent Component

rlc (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

4.1 rlc

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

Previous: , Up: Packages   [Contents][Index]

4.2 rlc-system

Source

rlc.asd.

Use List
  • asdf/interface.
  • common-lisp.

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Public Interface


5.1.1 Ordinary functions

Function: plot-series-rlc-current (v r l c t-inc t-end &optional t-start graph-function)
Package

rlc.

Source

main.lisp.

Function: series-rlc-current-formula (v r l c)

Returns formula for currrent through a series RLC circuit with a step-voltage applied at time 0.

Package

rlc.

Source

main.lisp.

Function: series-rlc-current-time (v r l c tm)
Package

rlc.

Source

main.lisp.

Function: write-series-rlc-current-graph-stream (out v r l c t-inc t-end &optional t-start)
Package

rlc.

Source

main.lisp.


5.2 Internals


Previous: , Up: Internals   [Contents][Index]

5.2.1 Ordinary functions

Function: circuit-type (r l c)
Package

rlc.

Source

main.lisp.

Function: run-xgraph (path)
Package

rlc.

Source

main.lisp.

Function: series-rlc-current-graph-data (v r l c t-inc t-end &optional t-start)
Package

rlc.

Source

main.lisp.

Function: write-series-rlc-current-graph (path v r l c t-inc t-end &optional t-start)
Package

rlc.

Source

main.lisp.


Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts


Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables