www.mooseframework.org
ConsoleUtils.h
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #pragma once
11 
12 // MOOSE includes
13 #include "Moose.h"
14 
15 // Forward declarations
16 class MooseApp;
17 class FEProblemBase;
18 class MooseObject;
19 
20 // libMesh forward declarations
21 namespace libMesh
22 {
23 class System;
24 }
25 
26 namespace ConsoleUtils
27 {
28 
30 static const unsigned int console_field_width = 27;
31 
33 static const unsigned int console_line_length = 100;
34 
38 std::string indent(unsigned int spaces);
39 
45 std::string outputFrameworkInformation(const MooseApp & app);
46 
50 std::string outputMeshInformation(FEProblemBase & problem, bool verbose = true);
51 
55 std::string outputAuxiliarySystemInformation(FEProblemBase & problem);
56 
61  const unsigned int nl_sys_num);
62 
66 std::string outputRelationshipManagerInformation(const MooseApp & app);
67 
71 std::string outputExecutionInformation(const MooseApp & app, FEProblemBase & problem);
72 
76 std::string outputOutputInformation(MooseApp & app);
77 
83 std::string outputSystemInformationHelper(System & system);
84 
88 std::string outputLegacyInformation(MooseApp & app);
89 
93 void insertNewline(std::stringstream & oss, std::streampos & begin, std::streampos & curr);
94 
101 std::string formatString(std::string message, const std::string & prefix);
102 
108 std::string mooseObjectVectorToString(const std::vector<MooseObject *> & objs,
109  const std::string & sep = " ");
110 } // ConsoleUtils namespace
std::string indent(unsigned int spaces)
Create empty string for indenting.
Definition: ConsoleUtils.C:31
std::string mooseObjectVectorToString(const std::vector< MooseObject *> &objs, const std::string &sep=" ")
Routine to output the name of MooseObjects in a string.
Definition: ConsoleUtils.C:438
std::string outputExecutionInformation(const MooseApp &app, FEProblemBase &problem)
Output execution information.
Definition: ConsoleUtils.C:316
std::string outputAuxiliarySystemInformation(FEProblemBase &problem)
Output the Auxiliary system information.
Definition: ConsoleUtils.C:142
Base class for MOOSE-based applications.
Definition: MooseApp.h:73
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:361
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:30
std::string outputSystemInformationHelper(System &system)
Output system information.
Definition: ConsoleUtils.C:288
std::string outputMeshInformation(FEProblemBase &problem, bool verbose=true)
Output the mesh information.
Definition: ConsoleUtils.C:55
static const unsigned int console_line_length
Line length for printing simulation information.
Definition: ConsoleUtils.h:33
Every object that can be built by the factory should be derived from this class.
Definition: MooseObject.h:33
void insertNewline(std::stringstream &oss, std::streampos &begin, std::streampos &curr)
Helper function function for stringstream formatting.
Definition: ConsoleUtils.C:411
std::string formatString(std::string message, const std::string &prefix)
Add new lines and prefixes to a string for pretty display in output NOTE: This makes a copy of the st...
Definition: ConsoleUtils.C:422
std::string outputFrameworkInformation(const MooseApp &app)
Outputs framework information.
Definition: ConsoleUtils.C:37
std::string outputLegacyInformation(MooseApp &app)
Output the legacy flag information.
Definition: ConsoleUtils.C:390
std::string outputRelationshipManagerInformation(const MooseApp &app)
Output action RelationshipManager information.
Definition: ConsoleUtils.C:296
std::string outputNonlinearSystemInformation(FEProblemBase &problem, const unsigned int nl_sys_num)
Output the Nonlinear system information.
Definition: ConsoleUtils.C:279