MAST::Utility::GetPotWrapper Class Reference

Detailed Description

Definition at line 33 of file getpot_wrapper.hpp.

#include <getpot_wrapper.hpp>

Public Member Functions
	GetPotWrapper (const int argc, char **argv, const std::string &input)
	Identifies if an input file name is provided in argc by the parameter name input. More...
	GetPotWrapper (const int argc, char **argv)
	creates a wrapper around the input arguments given to the executable in argc and argv More...
	GetPotWrapper (const std::string &file)
	creates a wrapper for the input arguments in the input file named file. More...
virtual	~GetPotWrapper ()
GetPot &	get ()
const char *	operator() (const std::string &nm, const std::string &doc, const char *v)
template<typename ValType >
ValType	operator() (const std::string &nm, const std::string &doc, const ValType &v)
template<typename ValType >
ValType	operator() (const std::string &nm, const std::string &doc, const ValType &v, const unsigned int i)
void	set_print (bool f)

Protected Attributes
GetPot *	_input
bool	_print

Constructor & Destructor Documentation

GetPotWrapper() [1/3]

MAST::Utility::GetPotWrapper::GetPotWrapper ( const int  argc, char **  argv, const std::string &  input  )

inline

Identifies if an input file name is provided in argc by the parameter name input.

If found, the input parameters are extracted from the input file, otherwise they are obtained from argc.

Definition at line 43 of file getpot_wrapper.hpp.

                                           :
    _input   (nullptr),
    _print   (false) {
        
        GetPot command_line(argc, argv);
        std::string
        input_name   = command_line(input,    "");
        
        if (input_name == "")
            _input = new GetPot(argc, argv);
        else
            _input = new GetPot(input_name);
        
        _print = (*_input)("print_params", false);
    }

GetPotWrapper() [2/3]

MAST::Utility::GetPotWrapper::GetPotWrapper ( const int  argc, char **  argv  )

inline

creates a wrapper around the input arguments given to the executable in argc and argv

Definition at line 66 of file getpot_wrapper.hpp.

                                              :
    _input   (new GetPot(argc, argv)),
    _print   (false) {}

GetPotWrapper() [3/3]

MAST::Utility::GetPotWrapper::GetPotWrapper ( const std::string &  file )

inline

creates a wrapper for the input arguments in the input file named file.

Definition at line 74 of file getpot_wrapper.hpp.

                                         :
    _input   (new GetPot(file)),
    _print   (false) {
        
    }

~GetPotWrapper()

virtual MAST::Utility::GetPotWrapper::~GetPotWrapper ( )

inlinevirtual

Definition at line 80 of file getpot_wrapper.hpp.

                             {
        delete _input;
    }

Member Function Documentation

get()

GetPot& MAST::Utility::GetPotWrapper::get ( )

inline

Definition at line 85 of file getpot_wrapper.hpp.

                  {
        return *_input;
    }

operator()() [1/3]

const char* MAST::Utility::GetPotWrapper::operator() ( const std::string &  nm, const std::string &  doc, const char *  v  )

inline

Definition at line 94 of file getpot_wrapper.hpp.

                                                                                     {
        
        if (_print)
            libMesh::out
            << nm << " : " << doc
            << "    [Default: v = " << v << " ]" << std::endl;
        
        return (*_input)(nm, v);
    }

operator()() [2/3]

template<typename ValType >

ValType MAST::Utility::GetPotWrapper::operator() ( const std::string &  nm, const std::string &  doc, const ValType &  v  )

inline

Definition at line 106 of file getpot_wrapper.hpp.

                                                                                    {
        
        if (_print)
            libMesh::out
            << nm << " : " << doc
            << "    [Default: v = " << v << " ]" << std::endl;
        
        return (*_input)(nm, v);
    }

operator()() [3/3]

template<typename ValType >

ValType MAST::Utility::GetPotWrapper::operator() ( const std::string &  nm, const std::string &  doc, const ValType &  v, const unsigned int  i  )

inline

Definition at line 117 of file getpot_wrapper.hpp.

                                                                                                          {
        
        
        if (_print)
            libMesh::out
            << "Vector: " << nm << " : " << doc
            << "    [ Default: v(i) = " << v << " ] " << std::endl;
        
        return (*_input)(nm, v, i);
    }

set_print()

void MAST::Utility::GetPotWrapper::set_print ( bool  f )

inline

Definition at line 89 of file getpot_wrapper.hpp.

                           {
        _print = f;
    }

Member Data Documentation

_input

GetPot* MAST::Utility::GetPotWrapper::_input

protected

Definition at line 131 of file getpot_wrapper.hpp.

_print

bool MAST::Utility::GetPotWrapper::_print

protected

Definition at line 132 of file getpot_wrapper.hpp.

---

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

• /home/travis/build/MASTmultiphysics/MAST3/include/mast/util/getpot_wrapper.hpp