ConsoleUtils.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

// MOOSE includes
#include "Moose.h"

// Forward declarations
class MooseApp;
class FEProblemBase;
class MooseObject;

// libMesh forward declarations
namespace libMesh
{
class System;
}

namespace ConsoleUtils
{

static const unsigned int console_field_width = 27;

static const unsigned int console_line_length = 100;

std::string indent(unsigned int spaces);

std::string outputFrameworkInformation(const MooseApp & app);

std::string outputMeshInformation(FEProblemBase & problem, bool verbose = true);

std::string outputAuxiliarySystemInformation(FEProblemBase & problem);

std::string outputSolverSystemInformation(FEProblemBase & problem,
                                          const unsigned int solver_sys_num);

std::string outputRelationshipManagerInformation(const MooseApp & app);

std::string outputExecutionInformation(const MooseApp & app, FEProblemBase & problem);

std::string outputOutputInformation(MooseApp & app);

std::string outputSystemInformationHelper(libMesh::System & system);

std::string outputPreSMOResidualInformation();

std::string outputLegacyInformation(MooseApp & app);

std::string outputDataFilePaths();

std::string outputDataFileParams(MooseApp & app);

void insertNewline(std::stringstream & oss, std::streampos & begin, std::streampos & curr);

std::string formatString(std::string message, const std::string & prefix);

std::string mooseObjectVectorToString(const std::vector<MooseObject *> & objs,
                                      const std::string & sep = " ");
} // ConsoleUtils namespace