Classes
class	SliceParser
	This class is a parser for slices of the form i:j:k where i, j and k are integers representing respectively the starting point, the stopping point and the period. More...

class	IntervalsParser
	This class is a parser for multiple slices of the form x,y,z,... where x, y and z are slices of the form i:j:k, as defined in the SliceParser class. This class contains a vector of SliceParsers. More...

class	BTDIntervalsParser
	This class is a parser for multiple slices of the form x,y,z,... where x, y and z are slices of the form i:j:k, as defined in the SliceParser class. This class contains a vector of SliceParsers. The supported function set differs from the IntervalsParser. More...

Functions
int	safeCastToInt (amrex::Real x, const std::string &real_name)
	Do a safe cast of a real to an int This ensures that the float value is within the range of ints and if not, raises an exception. More...

long	safeCastToLong (amrex::Real x, const std::string &real_name)
	Do a safe cast of a real to a long This ensures that the float value is within the range of longs and if not, raises an exception. More...

amrex::Parser	makeParser (std::string const &parse_function, amrex::Vector< std::string > const &varnames)
	Initialize an amrex::Parser object from a string containing a math expression. More...

void	Store_parserString (const amrex::ParmParse &pp, std::string query_string, std::string &stored_string)
	Parse a string (typically a mathematical expression) from the input file and store it into a variable. More...

double	parseStringtoDouble (const std::string &str)

int	parseStringtoInt (const std::string &str, const std::string &name)

template<int N>
amrex::ParserExecutor< N >	compileParser (amrex::Parser const *parser)

template<typename T >
int	queryWithParser (const amrex::ParmParse &a_pp, char const *const str, T &val)

template<typename T >
int	queryArrWithParser (const amrex::ParmParse &a_pp, char const *const str, std::vector< T > &val)

template<typename T >
int	queryArrWithParser (const amrex::ParmParse &a_pp, char const *const str, std::vector< T > &val, const int start_ix, const int num_val)

template<typename T >
void	getWithParser (const amrex::ParmParse &a_pp, char const *const str, T &val)

template<typename T >
void	getArrWithParser (const amrex::ParmParse &a_pp, char const *const str, std::vector< T > &val)

template<typename T >
void	getArrWithParser (const amrex::ParmParse &a_pp, char const *const str, std::vector< T > &val, const int start_ix, const int num_val)

Function Documentation

◆ compileParser()

template<int N>

amrex::ParserExecutor<N> utils::parser::compileParser ( amrex::Parser const * parser )

◆ getArrWithParser() [1/2]

template<typename T >

void utils::parser::getArrWithParser	(	const amrex::ParmParse &	a_pp,
		char const *const	str,
		std::vector< T > &	val
	)

◆ getArrWithParser() [2/2]

template<typename T >

void utils::parser::getArrWithParser	(	const amrex::ParmParse &	a_pp,
		char const *const	str,
		std::vector< T > &	val,
		const int	start_ix,
		const int	num_val
	)

Similar to amrex::ParmParse::get, but also supports math expressions for the value.

amrex::ParmParse::get reads a name and a value from the input file. This function does the same, and applies the Parser to the value, so the user has the choice to specify a value or a math expression (including user-defined constants). Works for amrex::Real numbers and integers.

Parameters

[in]	a_pp	amrex::ParmParse object
[in]	str	name of the parameter to read
[out]	val	where the value queried and parsed is stored
[in]	start_ix	start index in the list of inputs values (optional with arrays, default is amrex::ParmParse::FIRST for starting with the first input value)
[in]	num_val	number of input values to use (optional with arrays, default is amrex::ParmParse::LAST for reading until the last input value)

◆ getWithParser()

template<typename T >

void utils::parser::getWithParser	(	const amrex::ParmParse &	a_pp,
		char const *const	str,
		T &	val
	)

Similar to amrex::ParmParse::get, but also supports math expressions for the value.

amrex::ParmParse::get reads a name and a value from the input file. This function does the same, and applies the Parser to the value, so the user has the choice to specify a value or a math expression (including user-defined constants). Works for amrex::Real numbers and integers.

Parameters

[in]	a_pp	amrex::ParmParse object
[in]	str	name of the parameter to read
[out]	val	where the value queried and parsed is stored

◆ makeParser()

amrex::Parser utils::parser::makeParser	(	std::string const &	parse_function,
		amrex::Vector< std::string > const &	varnames
	)

Initialize an amrex::Parser object from a string containing a math expression.

Parameters

parse_function	String to read to initialize the parser.
varnames	A list of predefined independent variables

◆ parseStringtoDouble()

double utils::parser::parseStringtoDouble ( const std::string & str )

Parse a string and return as a double precision floating point number

In case the string cannot be interpreted as a double, this function ... <throws an exception? aborts with error message?>

Parameters

str	The string to be parsed

Returns: representation as a double

◆ parseStringtoInt()

int utils::parser::parseStringtoInt	(	const std::string &	str,
		const std::string &	name
	)

Parse a string and return an int

In case the string cannot be interpreted as Real, this function ... <throws an exception? aborts with error message?>

Parameters

str	The string to be parsed
name	For integers, the name, to be used in error messages

Returns: rounded closest integer

◆ queryArrWithParser() [1/2]

template<typename T >

int utils::parser::queryArrWithParser	(	const amrex::ParmParse &	a_pp,
		char const *const	str,
		std::vector< T > &	val
	)

◆ queryArrWithParser() [2/2]

template<typename T >

int utils::parser::queryArrWithParser	(	const amrex::ParmParse &	a_pp,
		char const *const	str,
		std::vector< T > &	val,
		const int	start_ix,
		const int	num_val
	)

Similar to amrex::ParmParse::query, but also supports math expressions for the value.

amrex::ParmParse::query reads a name and a value from the input file. This function does the same, and applies the amrex::Parser to the value, so the user has the choice to specify a value or a math expression (including user-defined constants). Works for amrex::Real numbers and integers.

Parameters

[in]	a_pp	amrex::ParmParse object
[in]	str	name of the parameter to read
[out]	val	where the value queried and parsed is stored, either a scalar or vector
[in]	start_ix	start index in the list of inputs values (optional with arrays, default is amrex::ParmParse::FIRST for starting with the first input value)
[in]	num_val	number of input values to use (optional with arrays, default is amrex::ParmParse::LAST for reading until the last input value)

◆ queryWithParser()

template<typename T >

int utils::parser::queryWithParser	(	const amrex::ParmParse &	a_pp,
		char const *const	str,
		T &	val
	)

Similar to amrex::ParmParse::query, but also supports math expressions for the value.

amrex::ParmParse::query reads a name and a value from the input file. This function does the same, and applies the amrex::Parser to the value, so the user has the choice to specify a value or a math expression (including user-defined constants). Works for amrex::Real numbers and integers.

Parameters

[in]	a_pp	amrex::ParmParse object
[in]	str	name of the parameter to read
[out]	val	where the value queried and parsed is stored, either a scalar or vector

◆ safeCastToInt()

int utils::parser::safeCastToInt	(	amrex::Real	x,
		const std::string &	real_name
	)

Do a safe cast of a real to an int This ensures that the float value is within the range of ints and if not, raises an exception.

Parameters

x	Real value to cast
real_name	String, the name of the variable being casted to use in the error message

◆ safeCastToLong()

long utils::parser::safeCastToLong	(	amrex::Real	x,
		const std::string &	real_name
	)

Do a safe cast of a real to a long This ensures that the float value is within the range of longs and if not, raises an exception.

Parameters

x	Real value to cast
real_name	String, the name of the variable being casted to use in the error message

◆ Store_parserString()

void utils::parser::Store_parserString	(	const amrex::ParmParse &	pp,
		std::string	query_string,
		std::string &	stored_string
	)

Parse a string (typically a mathematical expression) from the input file and store it into a variable.

Parameters

pp	used to read the query_string `pp.<function>=string`
query_string	ParmParse.query will look for this string
stored_string	variable in which the string to parse is stored

Classes

Functions

Function Documentation

◆ compileParser()

◆ getArrWithParser() [1/2]

◆ getArrWithParser() [2/2]

◆ getWithParser()

◆ makeParser()

◆ parseStringtoDouble()

◆ parseStringtoInt()

◆ queryArrWithParser() [1/2]

◆ queryArrWithParser() [2/2]

◆ queryWithParser()

◆ safeCastToInt()

◆ safeCastToLong()

◆ Store_parserString()