www.mooseframework.org
InputFileFormatter.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 #include "SyntaxTree.h"
13 
19 {
20 public:
21  InputFileFormatter(bool dump_mode);
22 
23  virtual std::string
24  printBlockOpen(const std::string & name, short depth, const std::string & /*doc*/) override;
25  virtual std::string printBlockClose(const std::string & name, short depth) const override;
26  virtual std::string printParams(const std::string & prefix,
27  const std::string & fully_qualified_name,
28  InputParameters & params,
29  short depth,
30  const std::string & search_string,
31  bool & found) override;
32 
33 protected:
34  bool _dump_mode;
35 };
36 
InputFileFormatter(bool dump_mode)
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.
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.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
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.
This class produces produces a dump of the InputFileParameters that appears like the normal input fil...