doxygen/moose/InputFileFormatter_8h_source.html

 //* 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

 #include "SyntaxTree.h"

 class InputFileFormatter : public SyntaxTree
 {
 public:
   InputFileFormatter(bool dump_mode);

   virtual std::string
   printBlockOpen(const std::string & name, short depth, const std::string & /*doc*/) override;
   virtual std::string printBlockClose(const std::string & name, short depth) const override;
   virtual std::string printParams(const std::string & prefix,
                                   const std::string & fully_qualified_name,
                                   InputParameters & params,
                                   short depth,
                                   const std::string & search_string,
                                   bool & found) override;

 protected:
   bool _dump_mode;
 };
name
std::string name(const ElemQuality q)

InputFileFormatter::InputFileFormatter
InputFileFormatter(bool dump_mode)
Definition: InputFileFormatter.C:18

SyntaxTree.h

InputFileFormatter::printBlockOpen
virtual std::string printBlockOpen(const std::string &name, short depth, const std::string &) override
This method is called at the beginning of each Node in the tree.
Definition: InputFileFormatter.C:21

InputFileFormatter::printBlockClose
virtual std::string printBlockClose(const std::string &name, short depth) const override
This method is called at the end of of each Node in the tree.
Definition: InputFileFormatter.C:35

InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
Definition: InputParameters.h:66

InputFileFormatter::_dump_mode
bool _dump_mode
Definition: InputFileFormatter.h:34

InputFileFormatter::printParams
virtual std::string printParams(const std::string &prefix, const std::string &fully_qualified_name, InputParameters &params, short depth, const std::string &search_string, bool &found) override
This function is called for each InputParameters object stored at a particular node.
Definition: InputFileFormatter.C:47

SyntaxTree
Definition: SyntaxTree.h:23

InputFileFormatter
This class produces produces a dump of the InputParameters that appears like the normal input file sy...
Definition: InputFileFormatter.h:18