diff options
Diffstat (limited to 'man/meantools-convert.1')
| -rw-r--r-- | man/meantools-convert.1 | 137 |
1 files changed, 137 insertions, 0 deletions
diff --git a/man/meantools-convert.1 b/man/meantools-convert.1 new file mode 100644 index 0000000..f29d877 --- /dev/null +++ b/man/meantools-convert.1 @@ -0,0 +1,137 @@ +.Dd $Mdocdate: June 12 2015 $ +.Dt meantools-convert 1.2 +.Os +.Sh NAME +.Nm meantools-convert +.Nd Translate flow equations to various formats +.Sh SYNOPSIS +.Nm +.Op Fl i Ar file +.Sy C +.Op Fl l Ar oldl_symbol +.Op Fl L Ar newl_symbol +.Op Fl C Ar constant_symbol +.Op Fl S +.Pp +.Nm +.Op Fl i Ar file +.Sy javascript +.Op Fl l Ar oldl_symbol +.Op Fl L Ar newl_symbol +.Op Fl C Ar constant_symbol +.Pp +.Nm +.Op Fl i Ar file +.Sy LaTeX +.Op Fl l Ar oldl_symbol +.Op Fl L Ar newl_symbol +.Op Fl C Ar constant_symbol +.Op Fl s +.Pp +.Sh DESCRIPTION +.Nm +is a python script to convert flow equations to C, javascript or LaTeX code. +.Pp +.Nm +is part of a set of tools to compute and manipulate Fermionic hierarchical flows: +.Bl -bullet +.It +.Sy meankondo +: computes flow equations for hierarchical Fermionic models +.It +.Sy numkondo +: numerical evaluation of flow equations. +.It +.Sy meantools, meantools-convert +: perform various operations on flow equations (derivation, exponentiation, evaluation and conversion to other formats). +.El +.Pp +as well as the following pre-processors, which generate configuration files for their associated model: +.Bl -bullet +.It +.Sy kondo_proprocess +: Kondo model +.El +.Pp +.Sh COMMAND-LINE ARGUMENTS +.Bl -tag -width Ds +.It Fl i Ar file +File containing the flow equation to convert. If this flag is not specified, then +.Nm +reads the equation from stdin. +.El +.Pp +.Sh C +.Nm +supports the following flags when converting to C code. +.Bl -tag -width Ds +.It Fl l Ar oldl_symbol +The symbol for the running coupling constants appearing on the right hand side (defaults to 'l'). +.It Fl L Ar newl_symbol +The symbol for the running coupling constants appearing on the left hand side (defaults to 'newL'). +.It Fl C Ar constant_symbol +The symbol for the constant factor (defaults to 'C'). Since there can be multiple constants in a flow equation, the actual symbols will be appended an integer (e.g. C1, C2, etc). +.It Fl S +Write each equation on a single line. +.El +.Pp +.Ar oldl_symbol +and +.Ar newl_symbol +must be arrays of floating point numbers (floats, doubles or long doubles) with enough memory allocated to them to hold all running coupling constants. Similarly, +.Ar constant_symbol Ns n +with n large enough must be allocated as floating point numbers. +.Pp +In addition, if the flow equation contains derivatives (see +.Sx meantools Ns (1) ) , +then +.Pf d Ar oldl_symbol , +.Pf d Ar newl_symbol +and +.Pf d Ar constant_symbol Ns n +must be allocated as well. The same holds for higher derivatives, with 'd' replaced by 'dd', 'ddd' and so forth. +.Sh JAVASCRIPT +.Qo +.Nm +.Sy javascript +.Qc +is a shorthand for +.Qo +.Nm +.Sy C +-S +.Qc +.Sh LATEX +.Nm +supports the following flags when converting to LaTeX code. +.Bl -tag -width Ds +.It Fl l Ar oldl_symbol +The symbol for the running coupling constants appearing on the right hand side (defaults to "\\ell"). +.It Fl L Ar newl_symbol +The symbol for the running coupling constants appearing on the left hand side (defaults to "\\ell'"). +.It Fl C Ar constant_symbol +The symbol for the constant factor (defaults to "C"). Since there can be multiple constants in a flow equation, the actual symbols will be appended an integer subscript (e.g. C_1, C_2, etc). +.It Fl s +Break the line at every '+'. +.El +.Pp +Since the length of the equations can change a lot from one system to another, +.Nm +does not make many formatting decisions (for instance +.Nm +does not insert any alignment characters, and either breaks the line at every '+' sign or at the end of the equation), which are left to the user. +.Pp +.Sh OUTPUT +.Nm +prints the converted flow equation to stdout. +.Pp +.Sh RETURN CODE +.Nm +returns 0 on success and -1 on error. +.Pp +.Sh SEE ALSO +.Sx meankondo Ns (1) +.Sx numkondo Ns (1) , +.Sx meantools Ns (1) , +.Sx kondo_preprocess Ns (1) +.Pp |