more docu.

This commit is contained in:
suter_a 2025-05-28 13:48:57 +02:00
parent 37f099542a
commit 15c5b02c8b
2 changed files with 18 additions and 0 deletions

View File

@ -37,6 +37,12 @@
#include "PGKT_LF.h"
//-----------------------------------------------------------------------------
/**
* <p>CTOR
*
* @param param [0] field (G), [1] width (1/us), [2] hopp (1/us)
* @param tmax maximal time to be used, default = 10 us
*/
PLGKT_LF::PLGKT_LF(std::vector<double> &param, const double tmax) : fParam(param), fTmax(tmax)
{
if (DynamicLGKTLF() == 0)

View File

@ -57,6 +57,18 @@ void lf_zf_approx(const bool gaussian, const std::vector<double> &param,
}
// ----------------------------------------------------------------------------
/**
* <p>write the polarization data to an ascii output file.
*
* @param fln filename
* @param zf_approx true for ZF approximation functions, otherwise full integration
* @param gaussian_only true for Gaussian, otherwise Gaussian/Lorentzian
* @param param [0] field (G), [1] width (1/us), [2] hopp (1/us)
* @param tt time vector
* @param pol polarization vector
*
* @return 0 on success, > 0 otherwise
*/
int lf_gl_write(const std::string fln, const bool zf_approx,
const bool gaussian_only,
const std::vector<double> &param,