www.mooseframework.org
ConsoleUtils.h
Go to the documentation of this file.
1 /****************************************************************/
2 /* DO NOT MODIFY THIS HEADER */
3 /* MOOSE - Multiphysics Object Oriented Simulation Environment */
4 /* */
5 /* (c) 2010 Battelle Energy Alliance, LLC */
6 /* ALL RIGHTS RESERVED */
7 /* */
8 /* Prepared by Battelle Energy Alliance, LLC */
9 /* Under Contract No. DE-AC07-05ID14517 */
10 /* With the U. S. Department of Energy */
11 /* */
12 /* See COPYRIGHT for full restrictions */
13 /****************************************************************/
14 
15 #ifndef CONSOLEUTILS_H
16 #define CONSOLEUTILS_H
17 
18 // MOOSE includes
19 #include "Moose.h"
20 
21 // Forward declarations
22 class MooseApp;
23 class FEProblemBase;
24 
25 // libMesh forward declarations
26 namespace libMesh
27 {
28 class System;
29 }
30 
31 namespace ConsoleUtils
32 {
33 
35 static const unsigned int console_field_width = 27;
36 
38 static const unsigned int console_line_length = 100;
39 
43 std::string indent(unsigned int spaces);
44 
50 std::string outputFrameworkInformation(MooseApp & app);
51 
55 std::string outputMeshInformation(FEProblemBase & problem, bool verbose = true);
56 
60 std::string outputAuxiliarySystemInformation(FEProblemBase & problem);
61 
65 std::string outputNonlinearSystemInformation(FEProblemBase & problem);
66 
70 std::string outputExecutionInformation(MooseApp & app, FEProblemBase & problem);
71 
75 std::string outputOutputInformation(MooseApp & app);
76 
82 std::string outputSystemInformationHelper(const System & system);
83 
87 void insertNewline(std::stringstream & oss, std::streampos & begin, std::streampos & curr);
88 
89 } // ConsoleUtils namespace
90 
91 #endif
std::string outputNonlinearSystemInformation(FEProblemBase &problem)
Output the Nonlinear system information.
Definition: ConsoleUtils.C:109
std::string indent(unsigned int spaces)
Create empty string for indenting.
Definition: ConsoleUtils.C:34
std::string outputAuxiliarySystemInformation(FEProblemBase &problem)
Output the Auxiliary system information.
Definition: ConsoleUtils.C:103
std::string outputSystemInformationHelper(const System &system)
Output system information.
Definition: ConsoleUtils.C:115
Base class for MOOSE-based applications.
Definition: MooseApp.h:58
The following methods are specializations for using the libMesh::Parallel::packed_range_* routines fo...
std::string outputOutputInformation(MooseApp &app)
Output the output information.
Definition: ConsoleUtils.C:240
Specialization of SubProblem for solving nonlinear equations plus auxiliary equations.
static const unsigned int console_field_width
Width used for printing simulation information.
Definition: ConsoleUtils.h:35
std::string outputMeshInformation(FEProblemBase &problem, bool verbose=true)
Output the mesh information.
Definition: ConsoleUtils.C:59
static const unsigned int console_line_length
Line length for printing simulation information.
Definition: ConsoleUtils.h:38
nl system()
void insertNewline(std::stringstream &oss, std::streampos &begin, std::streampos &curr)
Helper function function for stringstream formatting.
Definition: ConsoleUtils.C:269
std::string outputExecutionInformation(MooseApp &app, FEProblemBase &problem)
Output execution information.
Definition: ConsoleUtils.C:212
std::string outputFrameworkInformation(MooseApp &app)
Outputs framework information.
Definition: ConsoleUtils.C:40