Classes
class	FCSTdatabase
	This class is for interfacing with SQL databases, for the purpose of accessing and storing simulation results. More...

class	DatabaseOC
	This class is for storing a list of up to 10 parameters and is used as a way of informing the FCSTdatabase class about the model you wish to store/access. More...

class	FCSTLogStream
	The object FcstUtilities::log should be used throughout OpenFCST for console logging. More...

Functions
	DeclException1 (ExcWrongString, std::string,<< "Can't convert the string "<< arg1<< " to the desired Number type")
	Exception shown when a particular string can't be converted to Number type. More...

template<typename NumType >
NumType	string_to_number (const std::string &)
	Function to convert a std::string into Number template. More...

template<typename NumType >
std::vector< NumType >	string_to_number (const std::vector< std::string > &)
	Function to convert a std::vector< std::string > into std::vector < Number template >. More...

template<>
unsigned char	string_to_number< unsigned char > (const std::string &str)
	Function to convert a std::string into an unsigned char such as types::material_id and types::boundary_id. More...

template<typename KeyType , typename ValueType >
std::map< KeyType, ValueType >	string_to_map (const std::vector< std::string > &)
	Function to convert a std::vector< std::string > into std::map< KeyType, ValueType >. More...

template<typename KeyType , typename ValueType >
std::map< KeyType, ValueType >	string_to_map (const std::string &name)
	This function is the same as the previous one. More...

int	cellId_to_index (std::string &cell_id)
	This function determines whether a string is a "valid" representation of a number. More...

bool	is_number (const std::string &s)
	This function extracts to parent cell index from the dealii CellID. More...

template<typename KeyType , typename ValueType >
std::map< KeyType, std::vector < ValueType > >	split_mapvalue_list (const std::map< KeyType, std::string > &, const char delimiter= ';')
	This function takes a std::map<KeyType, std::string>, and std::string contains text separated by a `delimiter`. More...

void	print_parameter_file_PRM (ParameterHandler &param, std::string path="default.prm")
	This function prepares an PRM file with ALL your data inside. More...

void	print_parameter_file_XML (ParameterHandler &param, std::string path="default.xml")
	This function prepares an XML file with ALL your data inside. More...

std::string	find_fcst_root ()
	This function returns the address of the fcst root directory. More...

void	run_python (std::string script_name, std::string arg)
	This function runs external python scripts. More...

template<typename ValType >
void	modify_parameter_file (const std::string name_design_var, const ValType value_design_var, ParameterHandler &param)
	This routine is used to parse the input parameter. More...

template<typename ValType >
void	modify_parameter_file (const std::vector< std::string > name_design_var, const std::vector< ValType > value_design_var, ParameterHandler &param)

template<typename NumType >
std::string	number_to_string (const NumType &num)
	Function for casting from double to string. More...

void	read_parameter_files (ParameterHandler &param, const std::string &filename)
	This function reads parameter files written in both prm and xml formats. More...

bool	file_exists (const std::string &file_name)
	Check if a file exists. More...

Variables
FCSTLogStream	log
	Object used to output data to file and, if file attached recorded to a file as well. More...

Function Documentation

int FcstUtilities::cellId_to_index ( std::string & cell_id )

This function determines whether a string is a "valid" representation of a number.

Examples: Valid: "2.2", "-33", "-1.332" Invalid: "1+23.3", "2.2.2", "Bob"

See UtilsTest::testIsNumber in unit_test/source/utils_test.cc for more information.

FcstUtilities::DeclException1	(	ExcWrongString	,
		std::string	,
		<< "Can't convert the string "<< arg1<< " to the desired Number type"
	)

Exception shown when a particular string can't be converted to Number type.

bool FcstUtilities::file_exists ( const std::string & file_name )

Check if a file exists.

Adapted from http://stackoverflow.com/questions/12774207/fastest-way-to-check-if-a-file-exist-using-standard-c-c11-c

Parameters

file_name The file name or relative file path.

std::string FcstUtilities::find_fcst_root ( )

This function returns the address of the fcst root directory.

It presumes that you are executing from within the data folder - an exception will be thrown otherwise.

bool FcstUtilities::is_number ( const std::string & s )

This function extracts to parent cell index from the dealii CellID.

This is necessary for correlating the maps of field data in the microstructure simulations. Example: CellID: 511_0:8 would return 511 which is the index of the parent cell

template<typename ValType >

void FcstUtilities::modify_parameter_file	(	const std::string	name_design_var,
		const ValType	value_design_var,
		ParameterHandler &	param
	)

This routine is used to parse the input parameter.

Parameters

name_design_var for subsections and parameter name. This values are used to set the parameters specified as design variables.

The string should be of the form:

* set DV_0 = subsection_1>>subsection_2>>subsection_3>>parameter name:material_ID

*

This routine will go to the appropriate subsection in the ParameterHandler passed as input and will add the value in

Parameters

value_design_var to the ParameterHandler file

Author: M. Secanell and P. Wardlaw, 2014

template<typename ValType >

void FcstUtilities::modify_parameter_file	(	const std::vector< std::string >	name_design_var,
		const std::vector< ValType >	value_design_var,
		ParameterHandler &	param
	)

template<typename NumType >

std::string FcstUtilities::number_to_string ( const NumType & num )

Function for casting from double to string.

Uses boost lexical cast.

void FcstUtilities::print_parameter_file_PRM	(	ParameterHandler &	param,
		std::string	path = `"default.prm"`
	)

This function prepares an PRM file with ALL your data inside.

void FcstUtilities::print_parameter_file_XML	(	ParameterHandler &	param,
		std::string	path = `"default.xml"`
	)

This function prepares an XML file with ALL your data inside.

void FcstUtilities::read_parameter_files	(	ParameterHandler &	param,
		const std::string &	filename
	)

This function reads parameter files written in both prm and xml formats.

void FcstUtilities::run_python	(	std::string	script_name,
		std::string	arg
	)

This function runs external python scripts.

User must provide the script name and argument. It is presumed that the script resides in the python folder.

template<typename KeyType , typename ValueType >

std::map< KeyType, std::vector<ValueType> > FcstUtilities::split_mapvalue_list	(	const std::map< KeyType, std::string > &	,
		const char	delimiter = `';'`
	)

This function takes a std::map<KeyType, std::string>, and std::string contains text separated by a delimiter.

It splits the std::string into std::vector<ValueType>, removing all the leading and trailing spaces. It returns std::map< KeyType, std::vector<ValueType> >. The default value of the delimiter is semi-colon ";".

Note: It is necessary to have the delimiter "atleast once" in the Value string.

template<typename KeyType , typename ValueType >

std::map< KeyType, ValueType > FcstUtilities::string_to_map ( const std::vector< std::string > & )

Function to convert a std::vector< std::string > into std::map< KeyType, ValueType >.

This function is used to convert a string like "2 : 3.86" into a std::map where Key is 2 and Value is 3.86. This function is useful to convert a Patterns::Map (of ParameterHandler class of deal.ii) into a useful data map.

Warning: String should contain ":" to distinguish between key and corresponding value. Also a key should not be repeated in the parameter strings. Also Input strings should be free from blank spaces at the beginning and end.

Note: Currently, it is templated only to have < KeyType, ValueType > of: < unsigned int, double >, < std::string, double >, < unsigned int, std::string >, < unsigned char, double >. But, the capabilities can be extended.

template<typename KeyType , typename ValueType >

std::map< KeyType, ValueType > FcstUtilities::string_to_map ( const std::string & name )

This function is the same as the previous one.

The only difference is that this function takes std::string instead of std::vector<std::string>.

template<typename NumType >

NumType FcstUtilities::string_to_number ( const std::string & )

Function to convert a std::string into Number template.

Currently, it is templated only for double and unsigned int types. But it can be easily extended for other numeric data types.

Input string should be free from blank spaces at the beginning and end.

Note: There is a similar function in deal.ii Utilities namespace, but it has certain limitations as it doesn't do effective error checking for wrong input arguments. For that purpose, a new function is written here using boost::lexical_cast.

template<typename NumType >

std::vector<NumType> FcstUtilities::string_to_number ( const std::vector< std::string > & )

Function to convert a std::vector< std::string > into std::vector < Number template >.

Currently, it is templated only for double and unsigned int types. But it can be easily extended for other numeric data types.

Input strings should be free from blank spaces at the beginning and end.

Note: Before extending its capabilities to deal with other numeric data types, capability of string_to_number should be extended.

template<>

unsigned char FcstUtilities::string_to_number< unsigned char > ( const std::string & str )

Function to convert a std::string into an unsigned char such as types::material_id and types::boundary_id.

Variable Documentation

FCSTLogStream FcstUtilities::log

Object used to output data to file and, if file attached recorded to a file as well.

Classes

Functions

Variables

Function Documentation

Variable Documentation