oomph_utilities.cc File Reference
#include <algorithm>
#include <limits.h>
#include <cstring>
#include "oomph_utilities.h"
#include "Vector.h"
#include "matrices.h"

Namespaces

 oomph
 DRAIG: Change all instances of (SPATIAL_DIM) to (DIM-1).
 
 oomph::ANSIEscapeCode
 
 oomph::DebugHelpers
 
 oomph::SecondInvariantHelper
 
 oomph::BrokenCopy
 
 oomph::CumulativeTimings
 Namespace for global (cumulative) timings.
 
 oomph::StringConversion
 
 oomph::CommandLineArgs
 Namespace for command line arguments.
 
 oomph::ObsoleteCode
 Namespace for flagging up obsolete parts of the code.
 
 oomph::TecplotNames
 Namespace for tecplot stuff.
 
 oomph::PauseFlags
 Namespace for pause() command.
 
 oomph::TimingHelpers
 Helper for recording execution time.
 
 oomph::MemoryUsage
 

Functions

void oomph::ANSIEscapeCode::set_text_effect (std::string text_effect)
 
std::string oomph::DebugHelpers::debug_string (const std::string &filename, const int &line, const bool &make_new_line)
 
double oomph::SecondInvariantHelper::second_invariant (const DenseMatrix< double > &tensor)
 Compute second invariant of tensor. More...
 
void oomph::BrokenCopy::broken_assign (const std::string &class_name)
 Issue error message and terminate execution. More...
 
void oomph::BrokenCopy::broken_copy (const std::string &class_name)
 Issue error message and terminate execution. More...
 
void oomph::CumulativeTimings::start (const unsigned &i)
 (Re-)start i-th timer More...
 
void oomph::CumulativeTimings::halt (const unsigned &i)
 Halt i-th timer. More...
 
double oomph::CumulativeTimings::cumulative_time (const unsigned &i)
 Report time accumulated by i-th timer. More...
 
void oomph::CumulativeTimings::reset (const unsigned &i)
 Reset i-th timer. More...
 
void oomph::CumulativeTimings::reset ()
 Reset all timers. More...
 
void oomph::CumulativeTimings::set_ntimers (const unsigned &ntimers)
 Set number of timings that can be recorded in parallel. More...
 
std::string oomph::StringConversion::to_lower (const std::string &input)
 Convert a string to lower case (outputs a copy). More...
 
std::string oomph::StringConversion::to_upper (const std::string &input)
 Convert a string to upper case (outputs a copy). More...
 
void oomph::StringConversion::split_string (const std::string &s, char delim, Vector< std::string > &elems)
 
Vector< std::string > oomph::StringConversion::split_string (const std::string &s, char delim)
 
void oomph::CommandLineArgs::setup (int argc, char **argv)
 Set values. More...
 
void oomph::CommandLineArgs::output ()
 Doc the command line arguments. More...
 
void oomph::CommandLineArgs::specify_command_line_flag (const std::string &command_line_flag, const std::string &doc)
 Specify possible argument-free command line flag. More...
 
void oomph::CommandLineArgs::specify_command_line_flag (const std::string &command_line_flag, double *arg_pt, const std::string &doc)
 
void oomph::CommandLineArgs::specify_command_line_flag (const std::string &command_line_flag, int *arg_pt, const std::string &doc)
 
void oomph::CommandLineArgs::specify_command_line_flag (const std::string &command_line_flag, unsigned *arg_pt, const std::string &doc)
 
void oomph::CommandLineArgs::specify_command_line_flag (const std::string &command_line_flag, std::string *arg_pt, const std::string &doc)
 
bool oomph::CommandLineArgs::command_line_flag_has_been_set (const std::string &flag)
 
void oomph::CommandLineArgs::doc_all_flags (std::ostream &outstream)
 Document the values of all flags (specified or not). More...
 
void oomph::CommandLineArgs::doc_specified_flags ()
 Document specified command line flags. More...
 
void oomph::CommandLineArgs::doc_available_flags ()
 Document available command line flags. More...
 
void oomph::CommandLineArgs::check_arg_index (const int &argc, const int &arg_index)
 Helper function to check if command line index is legal. More...
 
void oomph::CommandLineArgs::parse_and_assign (int argc, char *argv[], const bool &throw_on_unrecognised_args)
 
void oomph::CommandLineArgs::parse_and_assign (const bool &throw_on_unrecognised_args)
 
void oomph::ObsoleteCode::obsolete ()
 Output warning message. More...
 
void oomph::ObsoleteCode::obsolete (const std::string &message)
 Ouput a warning message with a string argument. More...
 
void oomph::TecplotNames::setup ()
 Setup namespace. More...
 
void oomph::pause (std::string message)
 Pause and display message. More...
 
double oomph::TimingHelpers::timer ()
 returns the time in seconds after some point in past More...
 
std::string oomph::TimingHelpers::convert_secs_to_formatted_string (const double &time_in_sec)
 
void oomph::MemoryUsage::empty_my_memory_usage_file ()
 
void oomph::MemoryUsage::empty_total_memory_usage_file ()
 
void oomph::MemoryUsage::doc_total_memory_usage (const std::string &prefix_string)
 
void oomph::MemoryUsage::empty_memory_usage_files ()
 
void oomph::MemoryUsage::doc_memory_usage (const std::string &prefix_string)
 
void oomph::MemoryUsage::empty_top_file ()
 
void oomph::MemoryUsage::run_continous_top (const std::string &comment)
 
void oomph::MemoryUsage::stop_continous_top (const std::string &comment)
 
void oomph::MemoryUsage::insert_comment_to_continous_top (const std::string &comment)
 Insert comment into running continuous top output. More...
 

Variables

std::string oomph::ANSIEscapeCode::Text_effect = "1"
 Variable to decide on effects. More...
 
std::string oomph::ANSIEscapeCode::Black = "\033[" + Text_effect + ";30m"
 The code for each type of colour. More...
 
std::string oomph::ANSIEscapeCode::Red = "\033[" + Text_effect + ";31m"
 
std::string oomph::ANSIEscapeCode::Green = "\033[" + Text_effect + ";32m"
 
std::string oomph::ANSIEscapeCode::Yellow = "\033[" + Text_effect + ";33m"
 
std::string oomph::ANSIEscapeCode::Blue = "\033[" + Text_effect + ";34m"
 
std::string oomph::ANSIEscapeCode::Magenta = "\033[" + Text_effect + ";35m"
 
std::string oomph::ANSIEscapeCode::Cyan = "\033[" + Text_effect + ";36m"
 
std::string oomph::ANSIEscapeCode::Reset = "\033[0m"
 
Vector< clock_t > oomph::CumulativeTimings::Timing
 Cumulative timings. More...
 
Vector< clock_t > oomph::CumulativeTimings::Start_time
 Start times of active timers. More...
 
int oomph::CommandLineArgs::Argc
 Number of arguments + 1. More...
 
char ** oomph::CommandLineArgs::Argv
 Arguments themselves. More...
 
std::map< std::string, ArgInfo< bool > > oomph::CommandLineArgs::Specified_command_line_flag
 Map to indicate an input flag as having been set. More...
 
std::map< std::string, ArgInfo< double > > oomph::CommandLineArgs::Specified_command_line_double_pt
 Map to associate an input flag with a double – specified via pointer. More...
 
std::map< std::string, ArgInfo< int > > oomph::CommandLineArgs::Specified_command_line_int_pt
 Map to associate an input flag with an int – specified via pointer. More...
 
std::map< std::string, ArgInfo< unsigned > > oomph::CommandLineArgs::Specified_command_line_unsigned_pt
 Map to associate an input flag with an unsigned – specified via pointer. More...
 
std::map< std::string, ArgInfo< std::string > > oomph::CommandLineArgs::Specified_command_line_string_pt
 Map to associate an input flag with a string – specified via pointer. More...
 
bool oomph::ObsoleteCode::FlagObsoleteCode = true
 Flag up obsolete parts of the code. More...
 
Vector< std::string > oomph::TecplotNames::colour
 Tecplot colours. More...
 
bool oomph::PauseFlags::PauseFlag = true
 Flag to enable pausing code – pause the code by default. More...
 
bool oomph::MemoryUsage::Suppress_mpi_synchronisation = true
 
std::string oomph::MemoryUsage::My_memory_usage_system_string = "ps aux"
 
bool oomph::MemoryUsage::Bypass_all_memory_usage_monitoring = false
 
std::string oomph::MemoryUsage::My_memory_usage_filename = "my_memory_usage.dat"
 
std::string oomph::MemoryUsage::Total_memory_usage_system_string
 
std::string oomph::MemoryUsage::Total_memory_usage_filename = "memory_usage.dat"
 
std::string oomph::MemoryUsage::Top_system_string = "while true; do top -b -n 2 ; done "
 
std::string oomph::MemoryUsage::Top_output_filename = "top_output.dat"