Flow123d  release_2.2.0-914-gf1a3a4f
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
Application Class Reference

#include <main.h>

Inheritance diagram for Application:
Inheritance graph
[legend]
Collaboration diagram for Application:
Collaboration graph
[legend]

Public Member Functions

 TYPEDEF_ERR_INFO (EI_InputVersionStr, string)
 
 DECLARE_EXCEPTION (ExcVersionFormat,<< "Wrong format of the version specification: "<< EI_InputVersionStr::qval)
 
 Application (int argc, char **argv)
 Application constructor. More...
 
void display_version ()
 
Input::Record read_input ()
 
virtual ~Application ()
 Destructor. More...
 
- Public Member Functions inherited from ApplicationBase
void init (int argc, char **argv)
 

Static Public Member Functions

static Input::Type::Recordget_input_type ()
 Root of the Input::Type tree. Description of whole input structure. More...
 

Protected Member Functions

virtual void run ()
 
virtual void after_run ()
 
virtual void parse_cmd_line (const int argc, char **argv)
 
- Protected Member Functions inherited from ApplicationBase
 ApplicationBase (int argc, char **argv)
 
virtual ~ApplicationBase ()
 Destructor. More...
 
void system_init (MPI_Comm comm, const string &log_filename)
 
void petsc_initialize (int argc, char **argv)
 
int petcs_finalize ()
 

Private Member Functions

Input::Type::RevNumData get_rev_num_data ()
 Get version of program and other base data from rev_num.h and store them to map. More...
 

Private Attributes

HC_ExplicitSequentialproblem_
 Main Flow123d problem. More...
 
string main_input_filename_
 filename of main input file More...
 
string program_arguments_desc_
 Description of possible command line arguments. More...
 
bool use_profiler
 If true, we do output of profiling information. More...
 
bool yaml_balance_output_
 If true, preserves output of balance in YAML format. More...
 
Input::Record root_record
 root input record More...
 

Additional Inherited Members

- Static Public Attributes inherited from ApplicationBase
static const int exit_success = 0
 Return codes of application. More...
 
static const int exit_failure = 1
 
static const int exit_output = 0
 
static bool petsc_initialized = false
 
- Protected Attributes inherited from ApplicationBase
string log_filename_
 
string petsc_redirect_file_ =""
 
bool signal_handler_off_
 Turn off signal handling useful to debug with valgrind. More...
 
- Static Protected Attributes inherited from ApplicationBase
static FILE * petsc_output_ =NULL
 File handler for redirecting PETSc output. More...
 

Detailed Description

Definition at line 34 of file main.h.

Constructor & Destructor Documentation

Application::Application ( int  argc,
char **  argv 
)

Application constructor.

Definition at line 76 of file main.cc.

Application::~Application ( )
virtual

Destructor.

Definition at line 366 of file main.cc.

Member Function Documentation

void Application::after_run ( )
protectedvirtual

Check pause_after_run flag defined in input file.

Reimplemented from ApplicationBase.

Definition at line 356 of file main.cc.

Application::DECLARE_EXCEPTION ( ExcVersionFormat  ,
<< "Wrong format of the version specification: "<< EI_InputVersionStr::qval   
)
void Application::display_version ( )

Displays program version and build info. Pass version information to Profiler.

TODO: Split these two functionalities.

Definition at line 106 of file main.cc.

Here is the caller graph for this function:

it::Record & Application::get_input_type ( )
static

Root of the Input::Type tree. Description of whole input structure.

Definition at line 58 of file main.cc.

Here is the caller graph for this function:

Input::Type::RevNumData Application::get_rev_num_data ( )
private

Get version of program and other base data from rev_num.h and store them to map.

Definition at line 94 of file main.cc.

Here is the caller graph for this function:

void Application::parse_cmd_line ( const int  argc,
char **  argv 
)
protectedvirtual

Parse command line parameters.

Parameters
[in]argccommand line argument count
[in]argvcommand line arguments

Reimplemented from ApplicationBase.

Definition at line 146 of file main.cc.

Input::Record Application::read_input ( )

Read main input file

Returns accessor to the root Record.

Definition at line 124 of file main.cc.

Here is the caller graph for this function:

void Application::run ( )
protectedvirtual

Run application.

Read input and solve problem.

Implements ApplicationBase.

Definition at line 296 of file main.cc.

Application::TYPEDEF_ERR_INFO ( EI_InputVersionStr  ,
string   
)

Member Data Documentation

string Application::main_input_filename_
private

filename of main input file

Definition at line 97 of file main.h.

HC_ExplicitSequential* Application::problem_
private

Main Flow123d problem.

Definition at line 94 of file main.h.

string Application::program_arguments_desc_
private

Description of possible command line arguments.

Definition at line 103 of file main.h.

Input::Record Application::root_record
private

root input record

Definition at line 112 of file main.h.

bool Application::use_profiler
private

If true, we do output of profiling information.

Definition at line 106 of file main.h.

bool Application::yaml_balance_output_
private

If true, preserves output of balance in YAML format.

Definition at line 109 of file main.h.


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