Change the name of subroutines

[zhisong]

Stuart mentioned today that we can change the name of the subroutines that in the form of xx00aa.
The length of the new names must be 6 characters. I propose the following:
Old New Descriptions
pp00aa poinca Poincare plot
pp00ab ftrace field line tracing
ma00aa intgrl volume integrals
ma02aa bltrmi compute the local Beltrami solution
mp00ac iotait iteration over rotational transform
jo00aa flderr compute the field error
tr00ab denrgy compute the derivative of energy in each volume
sc00aa covfld compute co-variant field B
ra00aa wrtfld write vector potential to file

Please let me know if you have any ideas.

[SRHudson]

Hi, The routine "tr00ab" computes the rotational transform on the interfaces. I suggest that this be called "iniota" or something better. Regards, Stuart Dr. Stuart R. Hudson, Acting Head, Theory Department, http://theory.pppl.gov/, Princeton Plasma Physics Laboratory, https://www.pppl.gov/, P.O. Box 451, Princeton, NJ, 08543, USA GPS: 100 Stellarator Rd, Princeton, NJ, 08540 [email protected], phone +1(609)243-2631, fax +1(609)243-2662, cell phone +1 609 533 0566, https://zoom.us/j/815891149

…

On Tue, Apr 9, 2019 at 9:05 PM Zhisong Qu ***@***.***> wrote: Stuart mentioned today that we can change the name of the subroutines that in the form of xx00aa. The length of the new names must be 6 characters. I propose the following: *Old* *New* Descriptions *pp00aa* *poinca* Poincare plot *pp00ab* *ftrace* field line tracing *ma00aa* *intgrl* volume integrals *ma02aa* *bltrmi* compute the local Beltrami solution *mp00ac* *iotait* iteration over rotational transform *jo00aa* *flderr* compute the field error *tr00ab* *denrgy* compute the derivative of energy in each volume *sc00aa* *covfld* compute co-variant field B *ra00aa* *wrtfld* write vector potential to file Please let me know if you have any ideas. — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#63>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ALB7Oaxb5CUdyA4GoAY7lpUObXofTE8Cks5vfTjKgaJpZM4cl562> .

[zhisong]

Sorry my mistake. So we have
df00ab denrgy compute the derivative of energy in each volume for field Newton method
tr00ab iniota compute the rotational transform on the interfaces

[abaillod]

Hello!

I may have a suggestion on mp00ac.h and ma02aa.h. From what I understood in the code (please correct me if I am wrong...), ma02aa.h iterates on mp00ac.h to solve the beltrami field in one volume given some constraints (not necessarily iota, it can be another local constraint) and mp00ac.h solves the beltrami field given {\mu, \psi_p} and the geometry. Thus I would propose:

mp00ac bsolve Solve Beltrami field in one volume given the matrices dMA, dMB, dMD and dMG (which depend on {\mu, \psi_p} and the geometry)
ma02aa lciter Iterates on bsolve to match (local) constraint

note:
(1) I precise local constraint since I am currently working on global constraints, i.e. constraints that requires information from more than one volume to be computed (for example toroidal current). Following the terminology I used above, I will call gciter the routine which iterates on bsolve to match global constraints.
(2) If you want to keep the letters "fld" to denote the field (like in your proposal to rename ra00aa in wrtfld), we could also call mp00ac fldslv. I personaly find it a bit more obscure than bsolve!

This is only a suggestion, tell me what you think about it.