diff options
Diffstat (limited to 'Source/Utils/WarpXUtil.H')
| -rw-r--r-- | Source/Utils/WarpXUtil.H | 413 |
1 files changed, 0 insertions, 413 deletions
diff --git a/Source/Utils/WarpXUtil.H b/Source/Utils/WarpXUtil.H index 275ce7e31..c306a5a64 100644 --- a/Source/Utils/WarpXUtil.H +++ b/Source/Utils/WarpXUtil.H @@ -56,16 +56,6 @@ void CheckGriddingForRZSpectral (); void NullifyMF(amrex::MultiFab& mf, int lev, amrex::Real zmin, amrex::Real zmax); -/** - * \brief Parse a string (typically a mathematical expression) from the - * input file and store it into a variable. - * - * \param pp used to read the query_string `pp.<function>=string` - * \param query_string ParmParse.query will look for this string - * \param stored_string variable in which the string to parse is stored - */ -void Store_parserString(const amrex::ParmParse &pp, std::string query_string, - std::string& stored_string); namespace WarpXUtilIO{ /** @@ -80,77 +70,6 @@ bool WriteBinaryDataOnFile(std::string filename, const amrex::Vector<char>& data namespace WarpXUtilAlgo{ -/** \brief Returns a pointer to the first element in the range [first, last) that is greater than val - * - * A re-implementation of the upper_bound algorithm suitable for GPU kernels. - * - * @param first: pointer to left limit of the range to consider - * @param last: pointer to right limit of the range to consider - * @param val: value to compare the elements of [first, last) to - */ -template<typename T> AMREX_GPU_DEVICE AMREX_FORCE_INLINE -const T* upper_bound(const T* first, const T* last, const T& val) -{ - const T* it; - size_t count, step; - count = last-first; - while(count>0){ - it = first; - step = count/2; - it += step; - if (!(val<*it)){ - first = ++it; - count -= step + 1; - } - else{ - count = step; - } - } - return first; -} - -/** \brief Performs a linear interpolation - * - * Performs a linear interpolation at x given the 2 points - * (x0, f0) and (x1, f1) - */ -template<typename T> AMREX_GPU_DEVICE AMREX_FORCE_INLINE -T linear_interp(T x0, T x1, T f0, T f1, T x) -{ - return ((x1-x)*f0 + (x-x0)*f1)/(x1-x0); -} - -/** \brief Performs a bilinear interpolation - * - * Performs a bilinear interpolation at (x,y) given the 4 points - * (x0, y0, f00), (x0, y1, f01), (x1, y0, f10), (x1, y1, f11). - */ -template<typename T> AMREX_GPU_DEVICE AMREX_FORCE_INLINE -T bilinear_interp(T x0, T x1, T y0, T y1, T f00, T f01, T f10, T f11, T x, T y) -{ - const T fx0 = linear_interp(x0, x1, f00, f10, x); - const T fx1 = linear_interp(x0, x1, f01, f11, x); - return linear_interp(y0, y1, fx0, fx1, y); -} - -/** \brief Performs a trilinear interpolation - * - * Performs a trilinear interpolation at (x,y,z) given the 8 points - * (x0, y0, z0, f000), (x0, y0, z1, f001), (x0, y1, z0, f010), (x0, y1, z1, f011), - * (x1, y0, z0, f100), (x1, y0, z1, f101), (x1, y1, z0, f110), (x1, y1, z1, f111) - */ -template<typename T> AMREX_GPU_DEVICE AMREX_FORCE_INLINE -T trilinear_interp(T x0, T x1,T y0, T y1, T z0, T z1, - T f000, T f001, T f010, T f011, T f100, T f101, T f110, T f111, - T x, T y, T z) -{ - const T fxy0 = bilinear_interp( - x0, x1, y0, y1, f000, f010, f100, f110, x, y); - const T fxy1 = bilinear_interp( - x0, x1, y0, y1, f001, f011, f101, f111, x, y); - return linear_interp(z0, z1, fxy0, fxy1, z); -} - /** \brief Compute physical coordinates (x,y,z) that correspond to a given (i,j,k) and * the corresponding staggering, mf_type. * @@ -186,338 +105,6 @@ void getCellCoordinates (int i, int j, int k, } -/** -* \brief 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. -* -* \param x Real value to cast -* \param real_name String, the name of the variable being casted to use in the error message -*/ -int -safeCastToInt(amrex::Real x, const std::string& real_name); - -/** -* \brief 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. -* -* \param x Real value to cast -* \param real_name String, the name of the variable being casted to use in the error message -*/ -long -safeCastToLong(amrex::Real x, const std::string& real_name); - -/** -* \brief Initialize an amrex::Parser object from a string containing a math expression -* -* \param parse_function String to read to initialize the parser. -* \param varnames A list of predefined independent variables -*/ -amrex::Parser makeParser (std::string const& parse_function, amrex::Vector<std::string> const& varnames); - -/** Parse a string and return as a real - * - * In case the string cannot be interpreted as Real, - * this function ... <throws an exception? aborts with error message?> - * - * \param str The string to be parsed - * \return representation as real - */ -double parseStringtoReal(std::string str); - -/** 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?> - * - * \param str The string to be parsed - * \param name For integers, the name, to be used in error messages - * \return rounded closest integer - */ -int parseStringtoInt(std::string str, std::string name); - -template <int N> -amrex::ParserExecutor<N> compileParser (amrex::Parser const* parser) -{ - if (parser) { - return parser->compile<N>(); - } else { - return amrex::ParserExecutor<N>{}; - } -} - -/** 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. - * - * \param[in] a_pp amrex::ParmParse object - * \param[in] str name of the parameter to read - * \param[out] val where the value queried and parsed is stored, either a scalar or vector - */ -template <typename T> -int queryWithParser (const amrex::ParmParse& a_pp, char const * const str, T& val) -{ - // call amrex::ParmParse::query, check if the user specified str. - std::string tmp_str; - int is_specified = a_pp.query(str, tmp_str); - if (is_specified) - { - // If so, create a parser object and apply it to the value provided by the user. - std::string str_val; - Store_parserString(a_pp, str, str_val); - - auto parser = makeParser(str_val, {}); - - if (std::is_same<T, int>::value) { - - val = safeCastToInt(std::round(parser.compileHost<0>()()), str); - } - else if (std::is_same<T, long>::value) { - - val = safeCastToLong(std::round(parser.compileHost<0>()()), str); - } - else { - val = static_cast<T>(parser.compileHost<0>()()); - } - } - // return the same output as amrex::ParmParse::query - return is_specified; -} - -template <typename T> -int queryArrWithParser (const amrex::ParmParse& a_pp, char const * const str, std::vector<T>& val) -{ - // call amrex::ParmParse::query, check if the user specified str. - std::vector<std::string> tmp_str_arr; - int is_specified = a_pp.queryarr(str, tmp_str_arr); - if (is_specified) - { - // If so, create parser objects and apply them to the values provided by the user. - int const n = static_cast<int>(tmp_str_arr.size()); - val.resize(n); - for (int i=0 ; i < n ; i++) { - auto parser = makeParser(tmp_str_arr[i], {}); - if (std::is_same<T, int>::value) { - val[i] = safeCastToInt(std::round(parser.compileHost<0>()()), str); - } - else if (std::is_same<T, long>::value) { - val[i] = safeCastToLong(std::round(parser.compileHost<0>()()), str); - } - else { - val[i] = static_cast<T>(parser.compileHost<0>()()); - } - } - } - // return the same output as amrex::ParmParse::query - return is_specified; -} - -/** 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. - * - * \param[in] a_pp amrex::ParmParse object - * \param[in] str name of the parameter to read - * \param[out] val where the value queried and parsed is stored, either a scalar or vector - * \param[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) - * \param[in] num_val number of input values to use (optional with arrays, default is - * amrex::ParmParse::LAST for reading until the last input value) - */ -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) -{ - // call amrex::ParmParse::query, check if the user specified str. - std::vector<std::string> tmp_str_arr; - int is_specified = a_pp.queryarr(str, tmp_str_arr, start_ix, num_val); - if (is_specified) - { - // If so, create parser objects and apply them to the values provided by the user. - int const n = static_cast<int>(tmp_str_arr.size()); - val.resize(n); - for (int i=0 ; i < n ; i++) { - auto parser = makeParser(tmp_str_arr[i], {}); - if (std::is_same<T, int>::value) { - val[i] = safeCastToInt(std::round(parser.compileHost<0>()()), str); - } - else if (std::is_same<T, long>::value) { - val[i] = safeCastToLong(std::round(parser.compileHost<0>()()), str); - } - else { - val[i] = static_cast<T>(parser.compileHost<0>()()); - } - } - } - // return the same output as amrex::ParmParse::query - return is_specified; -} - -/** 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. - * - * \param[in] a_pp amrex::ParmParse object - * \param[in] str name of the parameter to read - * \param[out] val where the value queried and parsed is stored - */ -template <typename T> -void getWithParser (const amrex::ParmParse& a_pp, char const * const str, T& val) -{ - // If so, create a parser object and apply it to the value provided by the user. - std::string str_val; - Store_parserString(a_pp, str, str_val); - - auto parser = makeParser(str_val, {}); - if (std::is_same<T, int>::value) { - val = safeCastToInt(std::round(parser.compileHost<0>()()), str); - } - else if (std::is_same<T, long>::value) { - val = safeCastToLong(std::round(parser.compileHost<0>()()), str); - } - else { - val = static_cast<T>(parser.compileHost<0>()()); - } -} - -template <typename T> -void getArrWithParser (const amrex::ParmParse& a_pp, char const * const str, std::vector<T>& val) -{ - // Create parser objects and apply them to the values provided by the user. - std::vector<std::string> tmp_str_arr; - a_pp.getarr(str, tmp_str_arr); - - int const n = static_cast<int>(tmp_str_arr.size()); - val.resize(n); - for (int i=0 ; i < n ; i++) { - auto parser = makeParser(tmp_str_arr[i], {}); - if (std::is_same<T, int>::value) { - val[i] = safeCastToInt(std::round(parser.compileHost<0>()()), str); - } - else if (std::is_same<T, long>::value) { - val[i] = safeCastToLong(std::round(parser.compileHost<0>()()), str); - } - else { - val[i] = static_cast<T>(parser.compileHost<0>()()); - } - } -} - -/** 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. - * - * \param[in] a_pp amrex::ParmParse object - * \param[in] str name of the parameter to read - * \param[out] val where the value queried and parsed is stored - * \param[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) - * \param[in] num_val number of input values to use (optional with arrays, default is - * amrex::ParmParse::LAST for reading until the last input value) - */ -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) -{ - // Create parser objects and apply them to the values provided by the user. - std::vector<std::string> tmp_str_arr; - a_pp.getarr(str, tmp_str_arr, start_ix, num_val); - - int const n = static_cast<int>(tmp_str_arr.size()); - val.resize(n); - for (int i=0 ; i < n ; i++) { - auto parser = makeParser(tmp_str_arr[i], {}); - if (std::is_same<T, int>::value) { - val[i] = safeCastToInt(std::round(parser.compileHost<0>()()), str); - } - else if (std::is_same<T, long>::value) { - val[i] = safeCastToLong(std::round(parser.compileHost<0>()()), str); - } - else { - val[i] = static_cast<T>(parser.compileHost<0>()()); - } - } -} - -namespace WarpXUtilStr -{ - /** Return true if elem is in vect, false otherwise - * @param[in] vect vector of strings, typically names - * @param[in] elem single string - * @return true if elem is in vect, false otherwise - */ - bool is_in(const std::vector<std::string>& vect, - const std::string& elem); - - /** Return true if any element in elems is in vect, false otherwise - * @param[in] vect vector of strings, typically names - * @param[in] elems vector of string - * @return true if any element in elems is in vect, false otherwise - */ - bool is_in(const std::vector<std::string>& vect, - const std::vector<std::string>& elems); - - /** \brief Splits a string using a string separator. This is somewhat similar to - * amrex::Tokenize. The main difference is that, if the separator ":" is used, - * amrex::Tokenize will split ":3::2" into ["3","2"] while this functio will - * split ":3::2" into ["","3","","2"]. This function can also perform a trimming to - * remove whitespaces (or any other arbitrary string) from the split string. - * - * @tparam Container the type of the split string. - * - * @param[in] instr the input string - * @param[in] separator the separator string - * @param[in] trim true to trim the split string, false otherwise. - * @param[in] trim_space the string to trim if trim is true. - * @return cont the split string - */ - template <typename Container> - auto split (std::string const& instr, std::string const& separator, - bool const trim = false, std::string const& trim_space = " \t") - { - Container cont; - std::size_t current = instr.find(separator); - std::size_t previous = 0; - while (current != std::string::npos) { - if (trim){ - cont.push_back(amrex::trim(instr.substr(previous, current - previous),trim_space));} - else{ - cont.push_back(instr.substr(previous, current - previous));} - previous = current + separator.size(); - current = instr.find(separator, previous); - } - if (trim){ - cont.push_back(amrex::trim(instr.substr(previous, current - previous),trim_space));} - else{ - cont.push_back(instr.substr(previous, current - previous));} - return cont; - } - - /** \brief This function performs automatic text wrapping on a string, - * returning an array of strings each not exceeding the maximum line length - * (unless the text contains a word exceeding the maximum line length). - * - * @param[in] text the string containing the text to be wrapped - * @param[in] max_line_length the maximum line length - * @return an std::vector containing the lines of the wrapped text - */ - std::vector<std::string> automatic_text_wrap( - const std::string& text, const int max_line_length); - -} namespace WarpXUtilLoadBalance { |