Subroutines list
There are produced pdf documentations for each individual file. They contain some brief introductions. Here are the list and links.
Some of these might need to be updated. This is for the new version FOCUS. If you have questions, please contact Caoxiang Zhu.
| names | description | source | documentation |
|---|---|---|---|
| globals | declaring global variables | gloabls.f90 | globals.pdf |
| initial | initilization | initial.f90 | initial.pdf |
| rdsurf | read and discretize the unknot(toroidal) plasma boundary | rdsurf.f90 | rdsurf.pdf |
| rdknot | read and discretize the knotted boundary | rdknot.f90 | rdknot.pdf (need to be updated) |
| rdcoils | read and initilize the coils | rdcoils.f90 | rdcoils.pdf |
| rdknot | handling knotatron stuffs | rdknot.f90 | rdknot.pdf |
| bfield | Biot-Savart law for a current loop | bfield.f90 | bfield.pdf |
| bnormal | evaluate the normal field residue | bnormal.f90 | bnormal.pdf |
| bmnharm | evaluate the Bn spectrum difference | bmnharm.f90 | bmnharm.pdf |
| torflux | evaluate the toroidal flux error | torflux.f90 | torflux.pdf |
| length | evaluate the coil length constraint | length.f90 | length.pdf |
| curvature | coil curvature metric | curvature.f90 | curvature.pdf |
| torsion | evaluate the coil torsion | torsion.f90 | not fully documented |
| nissin | evaluate the coil Nissin complexity | nissin.f90 | nissin.pdf |
| surfsep | push coils away from any surfaces | surfsep.f90 | surfsep.pdf |
| coilsep | push coils away from any other | coilsep.f90 | coilsep.pdf |
| straight_out | Straighten the outboard section | straight_out.f90 | straight_out.pdf |
| solvers | interface for all the optimizers | solvers.f90 | solvers.pdf |
| descent | differential flow optimization | descent.f90 | descent.pdf |
| congrad | conjugate gradient optimization | congrad.f90 | congrad.pdf |
| lmalg | levenberg-marquardt optimization | lmalg.f90 | lmalg.pdf |
| saving | save the results | saving.f90 | saving.pdf |
| focus | main flow of the code | focus.f90 | focus.pdf |