LMU/musrfit
LMU/musrfit
5
0
Fork 0
Code Issues 6 Pull Requests Actions Packages Projects Releases 3 Activity

added some docu.

Browse Source
This commit is contained in:
suter_a 2021-08-18 19:17:18 +02:00
parent 4a2d865282
commit d332bffd29
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/external/Nonlocal/prog/dump_nonlocal_field.cpp vendored
View File

@ -48,6 +48,10 @@
#include "git-revision.h" #include "git-revision.h"
#endif #endif
//-----------------------------------------------------------------------------
/**
* <p>dump_nonlocal_field synatx console output.
*/
void dnlf_syntax() void dnlf_syntax()
{ {
std::cout << std::endl; std::cout << std::endl;
@ -60,6 +64,15 @@ void dnlf_syntax()
std::cout << std::endl << std::endl; std::cout << std::endl << std::endl;
} }
//-----------------------------------------------------------------------------
/**
* <p> reads the msr-file and estracts the necessary parameter information.
*
* @param fln msr-file name
* @param param parameter vector needed to calculate the magnetic field
*
* @return true, if everything went smoothly, false otherwise.
*/
bool dnlf_read_msr(const std::string fln, std::vector<double> &param) bool dnlf_read_msr(const std::string fln, std::vector<double> &param)
{ {
std::ifstream fin(fln.c_str(), std::ifstream::in); std::ifstream fin(fln.c_str(), std::ifstream::in);