oomph::ObsoleteCode Namespace Reference

Namespace for flagging up obsolete parts of the code. More...

Functions
void	obsolete ()
	Output warning message. More...
void	obsolete (const std::string &message)
	Ouput a warning message with a string argument. More...

Variables
bool	FlagObsoleteCode = true
	Flag up obsolete parts of the code. More...

Detailed Description

Namespace for flagging up obsolete parts of the code.

Function Documentation

obsolete() [1/2]

void oomph::ObsoleteCode::obsolete

(

)

Output warning message.

    {
      if (FlagObsoleteCode)
      {
        std::string junk;
        oomph_info << "\n\n--------------------------------------------\n";
        oomph_info << "You are using obsolete code " << std::endl;
        oomph_info << "--------------------------------------------\n\n";
        oomph_info << "Enter: \"s\" to suppress further messages" << std::endl;
        oomph_info << "       \"k\" to crash the code to allow a trace back in "
                      "the debugger"
                   << std::endl;
 
        oomph_info << "       any other key to continue\n \n";
        oomph_info << "                    [Note: Insert \n \n ";
        oomph_info << "                            "
                      "ObsoleteCode::FlagObsoleteCode=false;\n \n";
        oomph_info << "                     into your code to suppress these "
                      "messages \n";
        oomph_info << "                     altogether.] \n";
 
        std::cin >> junk;
        if (junk == "s")
        {
          FlagObsoleteCode = false;
        }
        if (junk == "k")
        {
          throw OomphLibError(
            "Killed", OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION);
        }
      }
    }

References FlagObsoleteCode, OOMPH_CURRENT_FUNCTION, OOMPH_EXCEPTION_LOCATION, oomph::oomph_info, and oomph::Global_string_for_annotation::string().

Referenced by obsolete(), and oomph::Preconditioner::setup().

obsolete() [2/2]

void oomph::ObsoleteCode::obsolete

(

const std::string &

message

)

Ouput a warning message with a string argument.

    {
      if (FlagObsoleteCode)
      {
        oomph_info << "\n\n------------------------------------" << std::endl;
        oomph_info << message << std::endl;
        oomph_info << "----------------------------------------" << std::endl;
 
        obsolete();
      }
    }

References FlagObsoleteCode, obsolete(), and oomph::oomph_info.

Variable Documentation

FlagObsoleteCode

bool oomph::ObsoleteCode::FlagObsoleteCode = true

Flag up obsolete parts of the code.

Referenced by obsolete().