DriverProgramComLine Class Reference

The ComLineObject for the example programs. More...

#include <DriverProgram.H>

Inheritance diagram for DriverProgramComLine:

Collaboration diagram for DriverProgramComLine:

Public Member Functions
	DriverProgramComLine ()
	DriverProgramComLine (const char *args[])
void	Initialize ()
	This is where the actual options and arguments are described. More...

Detailed Description

The ComLineObject for the example programs.

This comline object implements a basic command-line interface handler for the example programs. These command-line objects handle all of the generation of help messages, command line argument validation, and encapsulation.

Definition at line 75 of file DriverProgram.H.

Constructor & Destructor Documentation

DriverProgramComLine ( )

inline

Definition at line 78 of file DriverProgram.H.

        : IRAD::Util::ComLineObject()
      {};

DriverProgramComLine ( const char *  args[] )

inline

Definition at line 81 of file DriverProgram.H.

        : IRAD::Util::ComLineObject(args)
      {};

Member Function Documentation

void Initialize ( )

inline

This is where the actual options and arguments are described.

For details about what can be done in this function, see the documentation for the IRAD::Util::ComLineObject.

Definition at line 90 of file DriverProgram.H.

                       {
        AddOption('h',"help");
        //AddOption('q',"quadratic");
        AddOption('v',"verbosity",1);
        AddOption('o',"output",2,"filename");
        AddArgument("grid input> <bc input",1);
        AddHelp("help","Prints this long version of help.");
        AddHelp("output","Specifies the name of the output file.");
        std::ostringstream Ostr;
        //Ostr << "If using a mesh with tetrahedral elements, specifying" << std::endl
        //     << "this flag will cause the application to change the 4 node" << std::endl
        //     << " tetrahedra from input to 10 node quadratic tetrahedra";
        //AddHelp("quadratic",Ostr.str());
        Ostr.str("");
        Ostr << "GridConversion requires two arguments in order:" << std::endl
             << "                "
             << "su2 grid file> <bc file> where the su2 is a grid" << std::endl
             << "                 "
             << "analysis file output from Pointwise in Stanford format." << std::endl
             << "                "
             << "The bc file indicates a Rocfrac boundary condition for "
             << "each" << std::endl
             << "                domain." << std::endl
             << "                See the Grid Conversion User Manual for more "
             << "information on" << std::endl
             << "                the formats of these two files" << std::endl;
        AddArgHelp("grid input> <bc input",Ostr.str());
        // The following commented string formation is kept around to 
        // illustrate the required tabs and newlines to make the output 
        // look proper:
        //
        //    Ostr << "Use fixed problem size in scalability analysis.  Only makes"
        //         << "\n\t\tsense when scalability mode is enabled.";
        //    Ostr.str("");
        Ostr.str("");
        Ostr << "Main GridConversion program.";
        _description.assign(Ostr.str());

      };

---

The documentation for this class was generated from the following file:

• DriverProgram.H