File Write_txtlog.cpp

FileList > src > Write_txtlog.cpp

#include "Write_txtlog.h"

Public Functions

Type	Name
void	SaveParamtolog (Param XParam) Save model parameters to the log file. Saves the model parameters from the given Param object to the log file "BG_log.txt".
void	create_logfile () Create a log file for BG-Flood. Creates a log file named "BG_log.txt" for BG-Flood. The log file is reset if it already exists. The function also writes a header with the current date and time.
void	log (std::string text)
void	saveparam2netCDF (int ncid, int bgfid, Param XParam) Save model parameters to a NetCDF file. Saves the model parameters from the given Param object to a NetCDF file.
void	write_text_to_log_file (std::string text) Write text to the log file. Writes the given text to the log file "BG_log.txt".

Public Functions Documentation

function SaveParamtolog

Save model parameters to the log file. Saves the model parameters from the given Param object to the log file "BG_log.txt".

void SaveParamtolog (
    Param XParam
)

Parameters:

XParam The Param object containing the model parameters

function create_logfile

Create a log file for BG-Flood. Creates a log file named "BG_log.txt" for BG-Flood. The log file is reset if it already exists. The function also writes a header with the current date and time.

void create_logfile ()

function log

void log (
    std::string text
)

function saveparam2netCDF

Save model parameters to a NetCDF file. Saves the model parameters from the given Param object to a NetCDF file.

void saveparam2netCDF (
    int ncid,
    int bgfid,
    Param XParam
)

Parameters:

ncid The NetCDF file ID
bgfid The NetCDF group ID for the parameters
XParam The Param object containing the model parameters

function write_text_to_log_file

Write text to the log file. Writes the given text to the log file "BG_log.txt".

void write_text_to_log_file (
    std::string text
)

Parameters:

text The text to write to the log file

The documentation for this class was generated from the following file src/Write_txtlog.cpp