Classes | Namespaces | Functions | Variables
oomph_utilities.h File Reference

Go to the source code of this file.

Classes

class  oomph::DenseMatrix< T >
 Class for dense matrices, storing all the values of the matrix as a pointer to a pointer with assorted output functions inherited from Matrix<T>. The curious recursive template pattern is used here to pass the specific class to the base class so that round bracket access can be inlined. More...
 
class  oomph::AbsCmp< T >
 
class  oomph::Timer
 Timer. More...
 
class  oomph::DocLinearSolverInfo
 Collection of data structures for storing information about linear solves. Currently only contains storage for the iteration counts and the linear solver time. More...
 
class  oomph::DocInfo
 Information for documentation of results: Directory and file number to enable output in the form RESLT/filename11.dat, say. Documentation can be switched on and off. More...
 
struct  oomph::CommandLineArgs::ArgInfo< T >
 Structure to store information on a command line argument. More...
 
class  oomph::MPIOutputModifier
 
class  oomph::DenseMatrix< T >
 Class for dense matrices, storing all the values of the matrix as a pointer to a pointer with assorted output functions inherited from Matrix<T>. The curious recursive template pattern is used here to pass the specific class to the base class so that round bracket access can be inlined. More...
 
class  oomph::MPI_Helpers
 MPI_Helpers class contains static helper methods to support MPI within oomph-lib. The methods init(...) and finalize() initialize and finalize MPI in oomph-lib and manage the oomph-libs global communicator communicator_pt(). NOTE: This class encapsulates static helper methods and instances of it CANNOT be instantiated. More...
 
class  oomph::DenseMatrix< T >
 Class for dense matrices, storing all the values of the matrix as a pointer to a pointer with assorted output functions inherited from Matrix<T>. The curious recursive template pattern is used here to pass the specific class to the base class so that round bracket access can be inlined. More...
 
class  oomph::SolutionFunctorBase
 
class  oomph::SolutionFunctor
 

Namespaces

 oomph
 
 oomph::SecondInvariantHelper
 
 oomph::BrokenCopy
 
 oomph::MathematicalConstants
 
 oomph::StringConversion
 
 oomph::TypeNames
 
 oomph::CumulativeTimings
 Namespace for global (cumulative) timings.
 
 oomph::BlackBoxFDNewtonSolver
 Namespace for black-box FD Newton solver.
 
 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::LeakCheckNames
 
 oomph::PauseFlags
 Namespace for pause() command.
 
 oomph::TimingHelpers
 Helper for recording execution time.
 
 oomph::MemoryUsage
 

Functions

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...
 
const std::complex< double > oomph::MathematicalConstants::I (0.0, 1.0)
 The imaginary unit. More...
 
template<class T >
std::string oomph::StringConversion::to_string (T object, unsigned float_precision=8)
 Conversion function that should work for anything with operator<< defined (at least all basic types). 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)
 Split a string, s, into a vector of strings where ever there is an instance of delimiter (i.e. is delimiter is " " will give a list of words). Note that mutliple delimiters in a row will give empty strings. More...
 
Vector< std::string > oomph::StringConversion::split_string (const std::string &s, char delim)
 Split a string, s, into a vector of strings where ever there is an instance of delimiter (i.e. is delimiter is " " will give a list of words). Note that mutliple delimiters in a row will give empty strings. Return by value. More...
 
template<class T >
std::string oomph::TypeNames::get_type_name (T &obj)
 Get the type name of an object. Only for use in debugging, do not write real code using this function as it is implementation dependant! More...
 
template<class T >
std::string oomph::TypeNames::get_type_name (T *obj)
 Get the type name of an object from a pointer to the object (we usually want the type of the object itself not the pointer because the type of the pointer may be a base class). Only for use in debugging, do not write real code using this function as it is implementation dependant! 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...
 
void oomph::CumulativeTimings::reset (const unsigned &i)
 Reset i-th timer. More...
 
void oomph::CumulativeTimings::reset ()
 Reset all timers. More...
 
double oomph::CumulativeTimings::cumulative_time (const unsigned &i)
 Report time accumulated by i-th timer. More...
 
void oomph::CumulativeTimings::set_ntimers (const unsigned &ntimers)
 Set number of timings that can be recorded in parallel. More...
 
template<class Target , class Source >
Target oomph::checked_dynamic_cast (Source *x)
 Runtime checked dynamic cast. This is the safe but slightly slower cast. Use it in any of these cases: More...
 
template<class Target , class Source >
Target oomph::checked_static_cast (Source *x)
 Checked static cast. Only use this cast if ALL of these are true: More...
 
void oomph::BlackBoxFDNewtonSolver::black_box_fd_newton_solve (ResidualFctPt residual_fct, const Vector< double > &params, Vector< double > &unknowns)
 Black-box FD Newton solver: Calling sequence for residual function is. More...
 
void oomph::BlackBoxFDNewtonSolver::line_search (const Vector< double > &x_old, const double half_residual_squared_old, const Vector< double > &gradient, ResidualFctPt residual_fct, const Vector< double > &params, Vector< double > &newton_dir, Vector< double > &x, double &half_residual_squared, const double &stpmax)
 Line search helper for globally convergent Newton method. More...
 
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)
 Specify possible command line flag that specifies a double, accessed via pointer. More...
 
void oomph::CommandLineArgs::specify_command_line_flag (const std::string &command_line_flag, int *arg_pt, const std::string &doc)
 Specify possible command line flag that specifies an int, accessed via pointer. More...
 
void oomph::CommandLineArgs::specify_command_line_flag (const std::string &command_line_flag, unsigned *arg_pt, const std::string &doc)
 Specify possible command line flag that specifies an unsigned, accessed via pointer. More...
 
void oomph::CommandLineArgs::specify_command_line_flag (const std::string &command_line_flag, std::string *arg_pt, const std::string &doc)
 Specify possible command line flag that specifies a string, accessed via pointer. More...
 
bool oomph::CommandLineArgs::command_line_flag_has_been_set (const std::string &flag)
 Check if command line flag has been set (value will have been assigned directly). More...
 
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)
 Parse command line, check for recognised flags and assign associated values. More...
 
void oomph::CommandLineArgs::parse_and_assign (const bool &throw_on_unrecognised_args)
 Parse previously specified command line, check for recognised flags and assign associated values. More...
 
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::LeakCheckNames::reset ()
 
void oomph::LeakCheckNames::doc ()
 
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...
 
void oomph::MemoryUsage::empty_my_memory_usage_file ()
 Function to empty file that records my memory usage in file whose name is specified by My_memory_usage_filename. More...
 
void oomph::MemoryUsage::doc_my_memory_usage (const std::string &prefix_string)
 Doc my memory usage, prepended by string (which allows identification from where the function is called, say) that records memory usage in file whose name is specified by My_memory_usage_filename. Data is appended to that file; wipe it with empty_my_memory_usage_file(). Note: This requires getpid() which is defined in unistd.h so if you don't have that we won't build that function! More...
 
void oomph::MemoryUsage::empty_total_memory_usage_file ()
 Function to empty file that records total memory usage in file whose name is specified by Total_memory_usage_filename. More...
 
void oomph::MemoryUsage::doc_total_memory_usage (const std::string &prefix_string)
 Doc total memory usage, prepended by string (which allows identification from where the function is called, say) that records memory usage in file whose name is specified by Total_memory_usage_filename. Data is appended to that file; wipe it with empty_memory_usage_file(). More...
 
void oomph::MemoryUsage::empty_memory_usage_files ()
 Function to empty file that records total and local memory usage in appropriate files. More...
 
void oomph::MemoryUsage::doc_memory_usage (const std::string &prefix_string)
 Doc total and local memory usage, prepended by string (which allows identification from where the function is called, say). NOTE: Local memory usage only works if we have unistd.h header. More...
 
void oomph::MemoryUsage::empty_top_file ()
 Function to empty file that records continuous output from top in file whose name is specified by Top_output_filename. More...
 
void oomph::MemoryUsage::run_continous_top (const std::string &comment)
 Start running top continuously and output (append) into file specified by Top_output_filename. Wipe that file with empty_top_file() if you wish. Note that this is again quite Linux specific and unlikely to work on other operating systems. Insert optional comment into output file before starting. More...
 
void oomph::MemoryUsage::stop_continous_top (const std::string &comment)
 Stop running top continuously. Note that this is again quite Linux specific and unlikely to work on other operating systems. Insert optional comment into output file before stopping. More...
 
void oomph::MemoryUsage::insert_comment_to_continous_top (const std::string &comment)
 Insert comment into running continuous top output. More...
 

Variables

const double oomph::MathematicalConstants::Pi =3.1415926535897932384626433832795028841971693993751
 50 digits from maple More...
 
long oomph::LeakCheckNames::AlgebraicNodeNodeUpdateInfo_build