ConsoleUtils Namespace Reference

Functions
std::string	indent (unsigned int spaces)
	Create empty string for indenting. More...
std::string	outputFrameworkInformation (const MooseApp &app)
	Outputs framework information. More...
std::string	outputMeshInformation (FEProblemBase &problem, bool verbose=true)
	Output the mesh information. More...
std::string	outputAuxiliarySystemInformation (FEProblemBase &problem)
	Output the Auxiliary system information. More...
std::string	outputNonlinearSystemInformation (FEProblemBase &problem)
	Output the Nonlinear system information. More...
std::string	outputRelationshipManagerInformation (const MooseApp &app)
	Output action RelationshipManager information. More...
std::string	outputExecutionInformation (const MooseApp &app, FEProblemBase &problem)
	Output execution information. More...
std::string	outputOutputInformation (MooseApp &app)
	Output the output information. More...
std::string	outputSystemInformationHelper (System &system)
	Output system information. More...
std::string	outputLegacyInformation (MooseApp &app)
	Output the legacy flag information. More...
void	insertNewline (std::stringstream &oss, std::streampos &begin, std::streampos &curr)
	Helper function function for stringstream formatting. More...
std::string	outputSystemInformationHelper (std::stringstream &oss, System &system)

Variables
static const unsigned int	console_field_width = 27
	Width used for printing simulation information. More...
static const unsigned int	console_line_length = 100
	Line length for printing simulation information. More...

Function Documentation

indent()

std::string ConsoleUtils::indent

(

unsigned int

spaces

)

Create empty string for indenting.

Definition at line 30 of file ConsoleUtils.C.

{
  return std::string(spaces, ' ');
}

Referenced by JsonInputFileFormatter::addLine(), JsonInputFileFormatter::addParameters(), FEProblemBase::checkDependMaterialsHelper(), ControllableItem::dump(), ControllableAlias::dump(), ControlOutput::outputActiveObjects(), ControlOutput::outputControls(), YAMLFormatter::preTraverse(), SyntaxTree::TreeNode::print(), InputFileFormatter::printBlockClose(), InputFileFormatter::printBlockOpen(), YAMLFormatter::printBlockOpen(), YAMLFormatter::printParams(), and Console::write().

insertNewline()

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

Helper function function for stringstream formatting.

Definition at line 346 of file ConsoleUtils.C.

{
  if (curr - begin > console_line_length)
  {
    oss << "\n";
    begin = oss.tellp();
    oss << std::setw(console_field_width + 2) << ""; // "{ "
  }
}

Referenced by outputSystemInformationHelper(), and MaterialPropertyDebugOutput::printMaterialProperties().

outputAuxiliarySystemInformation()

std::string ConsoleUtils::outputAuxiliarySystemInformation

(

FEProblemBase &

problem

)

Output the Auxiliary system information.

Definition at line 109 of file ConsoleUtils.C.

{
  return outputSystemInformationHelper(problem.getAuxiliarySystem().system());
}

Referenced by Console::meshChanged(), and Console::outputSystemInformation().

outputExecutionInformation()

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

Output execution information.

Definition at line 261 of file ConsoleUtils.C.

{
 
  std::stringstream oss;
  oss << std::left;
 
  Executioner * exec = app.getExecutioner();
 
  oss << "Execution Information:\n"
      << std::setw(console_field_width) << "  Executioner: " << demangle(typeid(*exec).name())
      << '\n';
 
  std::string time_stepper = exec->getTimeStepperName();
  if (time_stepper != "")
    oss << std::setw(console_field_width) << "  TimeStepper: " << time_stepper << '\n';
 
  oss << std::setw(console_field_width)
      << "  Solver Mode: " << Moose::stringify(problem.solverParams()._type) << '\n';
 
  const std::string & pc_desc = problem.getPetscOptions().pc_description;
  if (!pc_desc.empty())
    oss << std::setw(console_field_width) << "  PETSc Preconditioner: " << pc_desc << '\n';
 
  MoosePreconditioner const * mpc = problem.getNonlinearSystemBase().getPreconditioner();
  if (mpc)
  {
    oss << std::setw(console_field_width)
        << "  MOOSE Preconditioner: " << mpc->getParamTempl<std::string>("_type");
    if (mpc->name() == "_moose_auto")
      oss << " (auto)";
    oss << '\n';
  }
  oss << '\n';
 
  return oss.str();
}

Referenced by Console::outputSystemInformation().

outputFrameworkInformation()

std::string ConsoleUtils::outputFrameworkInformation

(

const MooseApp &

app

)

Outputs framework information.

This includes the versions and timestamps

Definition at line 36 of file ConsoleUtils.C.

{
  std::stringstream oss;
  oss << std::left;
 
  if (app.getSystemInfo() != NULL)
    oss << app.getSystemInfo()->getInfo();
 
  oss << std::left << "Parallelism:\n"
      << std::setw(console_field_width)
      << "  Num Processors: " << static_cast<std::size_t>(app.n_processors()) << '\n'
      << std::setw(console_field_width)
      << "  Num Threads: " << static_cast<std::size_t>(libMesh::n_threads()) << '\n'
      << '\n';
 
  return oss.str();
}

Referenced by Console::outputSystemInformation().

outputLegacyInformation()

std::string ConsoleUtils::outputLegacyInformation

(

MooseApp &

app

)

Output the legacy flag information.

Definition at line 328 of file ConsoleUtils.C.

{
  std::stringstream oss;
  oss << std::left;
 
  if (app.parameters().get<bool>("use_legacy_dirichlet_bc"))
  {
    oss << COLOR_RED << "LEGACY MODES ENABLED:" << COLOR_DEFAULT << '\n';
    oss << " Default for parameter preset = false for all DirichletBC and ADDirichletBC objects.\n"
        << " Set use_legacy_dirichlet_bc = false in the application to change to the preferred "
           "behavior.\n"
        << COLOR_DEFAULT << '\n';
  }
 
  return oss.str();
}

Referenced by Console::outputSystemInformation().

outputMeshInformation()

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

Output the mesh information.

Definition at line 55 of file ConsoleUtils.C.

{
  std::stringstream oss;
  oss << std::left;
 
  MooseMesh & moose_mesh = problem.mesh();
  MeshBase & mesh = moose_mesh.getMesh();
 
  if (verbose)
  {
    bool forced = moose_mesh.isParallelTypeForced();
    bool pre_split = problem.getMooseApp().isUseSplit();
 
    // clang-format off
    oss << "Mesh: " << '\n'
        << std::setw(console_field_width)
        << "  Parallel Type: " << (moose_mesh.isDistributedMesh() ? "distributed" : "replicated")
        << (forced || pre_split ? " (" : "")
        << (forced ? "forced" : "")
        << (forced && pre_split ? ", " : "")
        << (pre_split ? "pre-split" : "")
        << (forced || pre_split ? ")" : "")
        << '\n'
        << std::setw(console_field_width) << "  Mesh Dimension: " << mesh.mesh_dimension() << '\n'
        << std::setw(console_field_width) << "  Spatial Dimension: " << mesh.spatial_dimension()
        << '\n';
    // clang-format on
  }
 
  oss << std::setw(console_field_width) << "  Nodes:" << '\n'
      << std::setw(console_field_width) << "    Total:" << mesh.n_nodes() << '\n'
      << std::setw(console_field_width) << "    Local:" << mesh.n_local_nodes() << '\n'
      << std::setw(console_field_width) << "  Elems:" << '\n'
      << std::setw(console_field_width) << "    Total:" << mesh.n_active_elem() << '\n'
      << std::setw(console_field_width) << "    Local:" << mesh.n_active_local_elem() << '\n';
 
  if (verbose)
  {
 
    oss << std::setw(console_field_width)
        << "  Num Subdomains: " << static_cast<std::size_t>(mesh.n_subdomains()) << '\n'
        << std::setw(console_field_width)
        << "  Num Partitions: " << static_cast<std::size_t>(mesh.n_partitions()) << '\n';
    if (problem.n_processors() > 1)
      oss << std::setw(console_field_width) << "  Partitioner: " << moose_mesh.partitionerName()
          << (moose_mesh.isPartitionerForced() ? " (forced) " : "") << '\n';
  }
 
  oss << '\n';
 
  return oss.str();
}

Referenced by Console::meshChanged(), and Console::outputSystemInformation().

outputNonlinearSystemInformation()

std::string ConsoleUtils::outputNonlinearSystemInformation

(

FEProblemBase &

problem

)

Output the Nonlinear system information.

Definition at line 216 of file ConsoleUtils.C.

{
  std::stringstream oss;
  oss << std::left;
 
#ifndef MOOSE_SPARSE_AD
  if (problem.haveADObjects())
  {
    oss << std::setw(console_field_width)
        << "  AD size required: " << problem.getNonlinearSystemBase().requiredDerivativeSize()
        << "\n";
  }
#endif
  return outputSystemInformationHelper(oss, problem.getNonlinearSystemBase().system());
}

Referenced by Console::meshChanged(), and Console::outputSystemInformation().

outputOutputInformation()

std::string ConsoleUtils::outputOutputInformation

(

MooseApp &

app

)

Output the output information.

Definition at line 299 of file ConsoleUtils.C.

{
  std::stringstream oss;
  oss << std::left;
 
  const std::vector<Output *> outputs = app.getOutputWarehouse().getOutputs<Output>();
  oss << "Outputs:\n";
  for (const auto & out : outputs)
  {
    // Display the "execute_on" settings
    const MultiMooseEnum & execute_on = out->executeOn();
    oss << "  " << std::setw(console_field_width - 2) << out->name() << "\"" << execute_on
        << "\"\n";
 
    // Display the advanced "execute_on" settings, only if they are different from "execute_on"
    if (out->isAdvanced())
    {
      const OutputOnWarehouse & adv_on = out->advancedExecuteOn();
      for (const auto & adv_it : adv_on)
        if (execute_on != adv_it.second)
          oss << "    " << std::setw(console_field_width - 4) << adv_it.first + ":"
              << "\"" << adv_it.second << "\"\n";
    }
  }
 
  return oss.str();
}

Referenced by Console::outputSystemInformation().

outputRelationshipManagerInformation()

std::string ConsoleUtils::outputRelationshipManagerInformation

(

const MooseApp &

app

)

Output action RelationshipManager information.

Definition at line 241 of file ConsoleUtils.C.

{
  std::stringstream oss;
  oss << std::left;
 
  auto info_strings = app.getRelationshipManagerInfo();
  if (info_strings.size())
  {
    for (const auto & info_pair : info_strings)
      oss << std::setw(console_field_width)
          << "  " + MooseUtils::underscoreToCamelCase(MooseUtils::toLower(info_pair.first), true) +
                 ":"
          << info_pair.second << '\n';
    oss << '\n';
  }
 
  return oss.str();
}

Referenced by Console::outputSystemInformation().

outputSystemInformationHelper() [1/2]

std::string ConsoleUtils::outputSystemInformationHelper	(	std::stringstream &	oss,
		System &	system
	)

Definition at line 115 of file ConsoleUtils.C.

{
  oss << std::left;
 
  if (system.n_dofs())
  {
    oss << std::setw(console_field_width) << "  Num DOFs: " << system.n_dofs() << '\n'
        << std::setw(console_field_width) << "  Num Local DOFs: " << system.n_local_dofs() << '\n';
 
    std::streampos begin_string_pos = oss.tellp();
    std::streampos curr_string_pos = begin_string_pos;
    oss << std::setw(console_field_width) << "  Variables: ";
    for (unsigned int vg = 0; vg < system.n_variable_groups(); vg++)
    {
      const VariableGroup & vg_description(system.variable_group(vg));
 
      if (vg_description.n_variables() > 1)
        oss << "{ ";
      for (unsigned int vn = 0; vn < vg_description.n_variables(); vn++)
      {
        oss << "\"" << vg_description.name(vn) << "\" ";
        curr_string_pos = oss.tellp();
        insertNewline(oss, begin_string_pos, curr_string_pos);
      }
 
      if (vg_description.n_variables() > 1)
        oss << "} ";
    }
    oss << '\n';
 
    begin_string_pos = oss.tellp();
    curr_string_pos = begin_string_pos;
    oss << std::setw(console_field_width) << "  Finite Element Types: ";
#ifndef LIBMESH_ENABLE_INFINITE_ELEMENTS
    for (unsigned int vg = 0; vg < system.n_variable_groups(); vg++)
    {
      oss << "\""
          << libMesh::Utility::enum_to_string<FEFamily>(
                 system.get_dof_map().variable_group(vg).type().family)
          << "\" ";
      curr_string_pos = oss.tellp();
      insertNewline(oss, begin_string_pos, curr_string_pos);
    }
    oss << '\n';
#else
    for (unsigned int vg = 0; vg < system.n_variable_groups(); vg++)
    {
      oss << "\""
          << libMesh::Utility::enum_to_string<FEFamily>(
                 system.get_dof_map().variable_group(vg).type().family)
          << "\", \""
          << libMesh::Utility::enum_to_string<FEFamily>(
                 system.get_dof_map().variable_group(vg).type().radial_family)
          << "\" ";
      curr_string_pos = oss.tellp();
      insertNewline(oss, begin_string_pos, curr_string_pos);
    }
    oss << '\n';
 
    begin_string_pos = oss.tellp();
    curr_string_pos = begin_string_pos;
    oss << std::setw(console_field_width) << "  Infinite Element Mapping: ";
    for (unsigned int vg = 0; vg < system.n_variable_groups(); vg++)
    {
      oss << "\""
          << libMesh::Utility::enum_to_string<InfMapType>(
                 system.get_dof_map().variable_group(vg).type().inf_map)
          << "\" ";
      curr_string_pos = oss.tellp();
      insertNewline(oss, begin_string_pos, curr_string_pos);
    }
    oss << '\n';
#endif
 
    begin_string_pos = oss.tellp();
    curr_string_pos = begin_string_pos;
    oss << std::setw(console_field_width) << "  Approximation Orders: ";
    for (unsigned int vg = 0; vg < system.n_variable_groups(); vg++)
    {
#ifndef LIBMESH_ENABLE_INFINITE_ELEMENTS
      oss << "\""
          << Utility::enum_to_string<Order>(system.get_dof_map().variable_group(vg).type().order)
          << "\" ";
#else
      oss << "\""
          << Utility::enum_to_string<Order>(system.get_dof_map().variable_group(vg).type().order)
          << "\", \""
          << Utility::enum_to_string<Order>(
                 system.get_dof_map().variable_group(vg).type().radial_order)
          << "\" ";
#endif
      curr_string_pos = oss.tellp();
      insertNewline(oss, begin_string_pos, curr_string_pos);
    }
    oss << "\n\n";
  }
 
  return oss.str();
}

outputSystemInformationHelper() [2/2]

std::string ConsoleUtils::outputSystemInformationHelper

(

System &

system

)

Output system information.

Parameters

system

The libMesh system to output

See also

outputAuxiliarySystemInformation outputNonlinearSystemInformation

Definition at line 233 of file ConsoleUtils.C.

{
  std::stringstream oss;
 
  return outputSystemInformationHelper(oss, system);
}

Referenced by outputAuxiliarySystemInformation(), and outputNonlinearSystemInformation().

Variable Documentation

console_field_width

const unsigned int ConsoleUtils::console_field_width = 27

static

Width used for printing simulation information.

Definition at line 29 of file ConsoleUtils.h.

Referenced by insertNewline(), ControlOutput::outputControls(), outputExecutionInformation(), outputFrameworkInformation(), outputMeshInformation(), outputNonlinearSystemInformation(), outputOutputInformation(), outputRelationshipManagerInformation(), outputSystemInformationHelper(), MaterialPropertyDebugOutput::printMaterialMap(), and MaterialPropertyDebugOutput::printMaterialProperties().

console_line_length

const unsigned int ConsoleUtils::console_line_length = 100

static

Line length for printing simulation information.

Definition at line 32 of file ConsoleUtils.h.

Referenced by insertNewline().