UserErrorChecking.h File Reference

#include "InputParameters.h"

Include dependency graph for UserErrorChecking.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
void	checkUnusedParam (const InputParameters &p, const std::vector< std::string > &names, const std::string &explanation, const bool error=false)
void	checkUnusedParam (const InputParameters &p, const std::string &name, const std::string &explanation, const bool error=false)
void	checkRequiredParam (const InputParameters &p, const std::vector< std::string > &names, const std::string &explanation)
void	checkRequiredParam (const InputParameters &p, const std::string &name, const std::string &explanation)
void	checkJointParams (const InputParameters &p, const std::vector< std::string > &name, const std::string &explanation)

Function Documentation

checkJointParams()

void checkJointParams	(	const InputParameters &	p,
		const std::vector< std::string > &	name,
		const std::string &	explanation
	)

Checks whether a set of parameters are all jointly provided or jointly not provided

Parameters

p	input parameters object
name	name of the input parameter
explanation	short explanation of the reason why parameter is required

checkRequiredParam() [1/2]

void checkRequiredParam	(	const InputParameters &	p,
		const std::vector< std::string > &	names,
		const std::string &	explanation
	)

Checks whether the user has specified an input parameter is set

Parameters

p	input parameters object
names	names of the input parameters
explanation	short explanation of the reason why parameter is required

checkRequiredParam() [2/2]

void checkRequiredParam	(	const InputParameters &	p,
		const std::string &	name,
		const std::string &	explanation
	)

Checks whether the user has specified an input parameter is set

Parameters

p	input parameters object
name	name of the input parameter
explanation	short explanation of the reason why parameter is required

checkUnusedParam() [1/2]

void checkUnusedParam	(	const InputParameters &	p,
		const std::vector< std::string > &	names,
		const std::string &	explanation,
		const bool	error = false
	)

Checks whether the user has specified an input parameter that will go un-used, printing an error message to help in the debugging process.

Parameters

p	input parameters object
names	names of the input parameters
explanation	short explanation of the reason why parameter is unused
error	whether to throw an error if parameter is unused

checkUnusedParam() [2/2]

void checkUnusedParam	(	const InputParameters &	p,
		const std::string &	name,
		const std::string &	explanation,
		const bool	error = false
	)

Checks whether the user has specified an input parameter that will go un-used, printing an error message to help in the debugging process.

Parameters

p	input parameters object
name	name of the input parameter
explanation	short explanation of the reason why parameter is unused
error	whether to throw an error if parameter is unused