LFMFModel.cpp File Reference

Implements top-level functions for running the LF/MF Propagation Model. More...

Functions
ReturnCode	CallLFMFModel (LFMFParams &lfmf_params, Result &result)
	Top-level control function for LFMF Model.
DrvrReturnCode	ParseLFMFInputStream (std::istream &stream, LFMFParams &lfmf_params)
	Parse input stream (file or string stream) to LFMF parameter struct.
DrvrReturnCode	ParseLFMFInputFile (const std::string &in_file, LFMFParams &lfmf_params)
	Parse LFMF Model input parameter file.
void	WriteLFMFInputs (std::ofstream &fp, const LFMFParams &params)
	Write LFMF Model inputs to the report file.
void	WriteLFMFOutputs (std::ofstream &fp, const Result &result)
	Write LFMF Model outputs to the report file.

Detailed Description

Implements top-level functions for running the LF/MF Propagation Model.

Function Documentation

CallLFMFModel()

ReturnCode CallLFMFModel	(	LFMFParams &	lfmf_params,
		Result &	result )

Top-level control function for LFMF Model.

Parameters

[in]	lfmf_params	LFMF Model input parameter struct
[out]	result	LFMF Results in Result struct

Returns

Return code

ParseLFMFInputFile()

DrvrReturnCode ParseLFMFInputFile	(	const std::string &	in_file,
		LFMFParams &	lfmf_params )

Parse LFMF Model input parameter file.

Parameters

[in]	in_file	Path to LFMF input parameter file
[out]	lfmf_params	LFMF input parameter struct

Returns

Return code

ParseLFMFInputStream()

DrvrReturnCode ParseLFMFInputStream	(	std::istream &	stream,
		LFMFParams &	lfmf_params )

Parse input stream (file or string stream) to LFMF parameter struct.

Parameters

[in]	stream	Input stream containing LFMF parameters
[out]	lfmf_params	LFMF input parameter struct

Returns

Return code

WriteLFMFInputs()

void WriteLFMFInputs	(	std::ofstream &	fp,
		const LFMFParams &	params )

Write LFMF Model inputs to the report file.

Parameters

[in]	fp	Output stream, a text file open for writing
[in]	params	LFMF input parameter struct

WriteLFMFOutputs()

void WriteLFMFOutputs	(	std::ofstream &	fp,
		const Result &	result )

Write LFMF Model outputs to the report file.

Parameters

[in]	fp	Output stream, a text file open for writing
[in]	result	LFMF output result struct