The rlc Reference Manual

Table of Contents

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

The rlc Reference Manual

This is the rlc Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:31:24 2018 GMT+0.


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

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.





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

2 Systems

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


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

2.1 rlc

Dependency

kmrcl

Source

rlc.asd (file)

Components

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

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 files   [Contents][Index]

3.1.1 rlc.asd

Location

rlc.asd

Systems

rlc (system)

Packages

rlc-system


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

3.1.2 rlc/package.lisp

Parent

rlc (system)

Location

package.lisp

Packages

rlc


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

3.1.3 rlc/main.lisp

Dependency

package.lisp (file)

Parent

rlc (system)

Location

main.lisp

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 rlc-system

Source

rlc.asd

Use List

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

4.2 rlc

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Functions

Function: plot-series-rlc-current V R L C T-INC T-END &optional T-START GRAPH-FUNCTION
Package

rlc

Source

main.lisp (file)

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 (file)

Function: series-rlc-current-time V R L C TM
Package

rlc

Source

main.lisp (file)

Function: write-series-rlc-current-graph-stream OUT V R L C T-INC T-END &optional T-START
Package

rlc

Source

main.lisp (file)


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

5.2 Internal definitions


Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Functions

Function: circuit-type R L C
Package

rlc

Source

main.lisp (file)

Function: run-xgraph PATH
Package

rlc

Source

main.lisp (file)

Function: series-rlc-current-graph-data V R L C T-INC T-END &optional T-START
Package

rlc

Source

main.lisp (file)

Function: write-series-rlc-current-graph PATH V R L C T-INC T-END &optional T-START
Package

rlc

Source

main.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   R  
Index Entry  Section

F
File, Lisp, rlc.asd: The rlc<dot>asd file
File, Lisp, rlc/main.lisp: The rlc/main<dot>lisp file
File, Lisp, rlc/package.lisp: The rlc/package<dot>lisp file

L
Lisp File, rlc.asd: The rlc<dot>asd file
Lisp File, rlc/main.lisp: The rlc/main<dot>lisp file
Lisp File, rlc/package.lisp: The rlc/package<dot>lisp file

R
rlc.asd: The rlc<dot>asd file
rlc/main.lisp: The rlc/main<dot>lisp file
rlc/package.lisp: The rlc/package<dot>lisp file

Jump to:   F   L   R  

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

A.2 Functions

Jump to:   C   F   P   R   S   W  
Index Entry  Section

C
circuit-type: Internal functions

F
Function, circuit-type: Internal functions
Function, plot-series-rlc-current: Exported functions
Function, run-xgraph: Internal functions
Function, series-rlc-current-formula: Exported functions
Function, series-rlc-current-graph-data: Internal functions
Function, series-rlc-current-time: Exported functions
Function, write-series-rlc-current-graph: Internal functions
Function, write-series-rlc-current-graph-stream: Exported functions

P
plot-series-rlc-current: Exported functions

R
run-xgraph: Internal functions

S
series-rlc-current-formula: Exported functions
series-rlc-current-graph-data: Internal functions
series-rlc-current-time: Exported functions

W
write-series-rlc-current-graph: Internal functions
write-series-rlc-current-graph-stream: Exported functions

Jump to:   C   F   P   R   S   W  

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

A.3 Variables


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

A.4 Data types

Jump to:   P   R   S  
Index Entry  Section

P
Package, rlc: The rlc package
Package, rlc-system: The rlc-system package

R
rlc: The rlc system
rlc: The rlc package
rlc-system: The rlc-system package

S
System, rlc: The rlc system

Jump to:   P   R   S