#include <ExodusFormatter.h>

Inheritance diagram for ExodusFormatter:

Public Member Functions
	ExodusFormatter ()

void	printInputFile (ActionWarehouse &wh)

void	format ()

std::vector< std::string > &	getInputFileRecord ()

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. More...

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. More...

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. More...

void	insertNode (std::string syntax, const std::string &action, bool is_action_params=true, InputParameters *params=NULL)

std::string	print (const std::string &search_string)

void	seenIt (const std::string &prefix, const std::string &item)

bool	haveSeenIt (const std::string &prefix, const std::string &item) const

virtual std::string	preamble () const
	This method is called once at the beginning of the tree traversal and can be used to build up header information. More...

virtual std::string	postscript () const
	This method is called once at the end of the tree traversal and can be used to add any necessary trailing information to the final formatted string. More...

virtual std::string	preTraverse (short) const
	This method is called once at each node in the syntax tree before traversing child nodes. More...

Protected Member Functions
bool	isLongNames () const

Protected Attributes
std::stringstream	_ss

std::vector< std::string >	_input_file_record

bool	_dump_mode

TreeNode *	_root

bool	_use_long_names

Detailed Description

Definition at line 15 of file ExodusFormatter.h.

Constructor & Destructor Documentation

◆ ExodusFormatter()

ExodusFormatter::ExodusFormatter ( )

Definition at line 23 of file ExodusFormatter.C.

23 : InputFileFormatter(false) {}

InputFileFormatter::InputFileFormatter

InputFileFormatter(bool dump_mode)

Definition: InputFileFormatter.C:17

Member Function Documentation

◆ format()

void ExodusFormatter::format ( )

Definition at line 49 of file ExodusFormatter.C.

Referenced by Exodus::outputInput().

 {
   std::string s;
   _input_file_record.clear();
 
   while (std::getline(_ss, s))
   {
     // MAX_LINE_LENGTH is from ExodusII
     if (s.length() > MAX_LINE_LENGTH)
     {
       const std::string continuation("...");
       const size_t cont_len = continuation.length();
       size_t num_lines = s.length() / (MAX_LINE_LENGTH - cont_len) + 1;
       std::string split_line;
       for (size_t j = 0, l_begin = 0; j < num_lines; ++j, l_begin += MAX_LINE_LENGTH - cont_len)
       {
         size_t l_len = MAX_LINE_LENGTH - cont_len;
         if (s.length() < l_begin + l_len)
           l_len = s.length() - l_begin;
 
         split_line = s.substr(l_begin, l_len);
 
         if (l_begin + l_len != s.length())
           split_line += continuation;
 
         _input_file_record.push_back(split_line);
       }
     }
     else
       _input_file_record.push_back(s);
   }
 }

◆ getInputFileRecord()

std::vector<std::string>& ExodusFormatter::getInputFileRecord ( )

inline

Definition at line 24 of file ExodusFormatter.h.

Referenced by Exodus::outputInput().

24 { return _input_file_record; }

ExodusFormatter::_input_file_record

std::vector< std::string > _input_file_record

Definition: ExodusFormatter.h:28

◆ haveSeenIt()

bool SyntaxTree::haveSeenIt	(	const std::string &	prefix,
		const std::string &	item
	)		const

inherited

Definition at line 63 of file SyntaxTree.C.

Referenced by InputFileFormatter::printParams(), and YAMLFormatter::printParams().

 {
   return _params_printed.find(prefix + item) != _params_printed.end();
 }

◆ insertNode()

void SyntaxTree::insertNode	(	std::string	syntax,
		const std::string &	action,
		bool	is_action_params = `true`,
		InputParameters *	params = `NULL`
	)

inherited

Definition at line 27 of file SyntaxTree.C.

Referenced by ActionWarehouse::printInputFile().

 {
   if (_root == NULL)
     _root = new TreeNode("", *this);
 
   _root->insertNode(syntax, action, is_action_params, params);
 }

◆ isLongNames()

bool SyntaxTree::isLongNames ( ) const

protectedinherited

Definition at line 236 of file SyntaxTree.C.

 {
   return _use_long_names;
 }

◆ postscript()

virtual std::string SyntaxFormatterInterface::postscript ( ) const

inlinevirtualinherited

This method is called once at the end of the tree traversal and can be used to add any necessary trailing information to the final formatted string.

Returns: - The formatted postscript string

Reimplemented in YAMLFormatter.

Definition at line 46 of file SyntaxFormatterInterface.h.

Referenced by SyntaxTree::print().

46 { return std::string(); }

◆ preamble()

virtual std::string SyntaxFormatterInterface::preamble ( ) const

inlinevirtualinherited

This method is called once at the beginning of the tree traversal and can be used to build up header information.

Returns: - The formatted preamble string

Reimplemented in YAMLFormatter.

Definition at line 38 of file SyntaxFormatterInterface.h.

Referenced by SyntaxTree::print().

38 { return std::string(); }

◆ preTraverse()

virtual std::string SyntaxFormatterInterface::preTraverse ( short ) const

inlinevirtualinherited

This method is called once at each node in the syntax tree before traversing child nodes.

Returns: - The formatted pre-node traversal string

Reimplemented in YAMLFormatter.

Definition at line 52 of file SyntaxFormatterInterface.h.

52 { return std::string(); }

◆ print()

std::string SyntaxTree::print ( const std::string & search_string )

inherited

Definition at line 39 of file SyntaxTree.C.

Referenced by ActionWarehouse::printInputFile().

 {
   bool found = false;
   std::string output;
 
   // Clear the list of "seen" parameters before printing the tree
   _params_printed.clear();
 
   if (_root)
     output = _root->print(-1, search_string, found);
 
   if (found)
     return preamble() + output + postscript();
   else
     return "";
 }

◆ printBlockClose()

std::string InputFileFormatter::printBlockClose	(	const std::string &	name,
		short	depth
	)		const

overridevirtualinherited

This method is called at the end of of each Node in the tree.

It is typically used to provide formatting necessary when closing blocks.

Returns: - The formatted block close string

Implements SyntaxFormatterInterface.

Definition at line 34 of file InputFileFormatter.C.

 {
   std::string indent(depth * 2, ' ');
   std::string closing_string;
 
   if (depth)
     closing_string = "../";
 
   return std::string("") + indent + "[" + closing_string + "]\n";
 }

◆ printBlockOpen()

std::string InputFileFormatter::printBlockOpen	(	const std::string &	name,
		short	depth,
		const std::string &	doc
	)

overridevirtualinherited

This method is called at the beginning of each Node in the tree.

It is typically used to provide formatting necessary when opening new blocks.

Returns: - The formatted block open string

Implements SyntaxFormatterInterface.

Definition at line 20 of file InputFileFormatter.C.

 {
   std::string indent(depth * 2, ' ');
   std::string opening_string;
 
   if (depth)
     opening_string = "./";
 
   return std::string("\n") + indent + "[" + opening_string + name + "]\n";
 }

◆ printInputFile()

void ExodusFormatter::printInputFile ( ActionWarehouse & wh )

Definition at line 26 of file ExodusFormatter.C.

Referenced by Exodus::outputInput().

 {
   _ss << "####################\n"
       << "# Created by MOOSE #\n"
       << "####################\n";
 
   // Grab the command line arguments first
   _ss << "### Command Line Arguments ###\n";
   if (wh.mooseApp().commandLine())
   {
     for (const auto & arg : wh.mooseApp().commandLine()->getArguments())
       _ss << " " << arg;
   }
   if (wh.mooseApp().getSystemInfo() != NULL)
   {
     _ss << "### Version Info ###\n" << wh.mooseApp().getSystemInfo()->getInfo() << "\n";
   }
 
   _ss << "### Input File ###" << std::endl;
   wh.printInputFile(_ss);
 }

◆ printParams()

std::string InputFileFormatter::printParams	(	const std::string &	prefix,
		const std::string &	fully_qualified_name,
		InputParameters &	params,
		short	depth,
		const std::string &	search_string,
		bool &	found
	)

overridevirtualinherited

This function is called for each InputParameters object stored at a particular node.

It is responsible for formatting the parameters for the current node.

Returns: - The formatted parameters string for a Node.

Implements SyntaxFormatterInterface.

Definition at line 46 of file InputFileFormatter.C.

 {
   std::stringstream oss;
 
   std::string quotes = "";
   std::string spacing = "";
   std::string forward = "";
   std::string backdots = "";
   int offset = 30;
   for (int i = 0; i < depth; ++i)
   {
     spacing += "  ";
     forward = ".";
     offset -= 2;
   }
 
   for (const auto & iter : params)
   {
     // We only want non-private params and params that we haven't already seen
     if (params.isPrivate(iter.first) || haveSeenIt(fully_qualified_name, iter.first))
       continue;
 
     std::string value = "INVALID";
     if (params.isParamValid(iter.first))
     {
       // Print the parameter's value to a stringstream.
       std::ostringstream toss;
       iter.second->print(toss);
       value = MooseUtils::trim(toss.str());
     }
     else if (params.hasDefaultCoupledValue(iter.first))
     {
       std::ostringstream toss;
       toss << params.defaultCoupledValue(iter.first);
       value = toss.str();
     }
 
     // See if we match the search string
     if (MooseUtils::wildCardMatch(iter.first, search_string) ||
         MooseUtils::wildCardMatch(value, search_string))
     {
       // Don't print active if it is the default all, that means it's not in the input file - unless
       // of course we are in dump mode
       if (!_dump_mode && iter.first == "active")
       {
         libMesh::Parameters::Parameter<std::vector<std::string>> * val =
             dynamic_cast<libMesh::Parameters::Parameter<std::vector<std::string>> *>(iter.second);
         const std::vector<std::string> & active = val->get();
         if (val != NULL && active.size() == 1 && active[0] == "__all__")
           continue;
       }
 
       // Mark it as "seen"
       seenIt(fully_qualified_name, iter.first);
 
       // Don't print type if it is blank
       if (iter.first == "type")
       {
         libMesh::Parameters::Parameter<std::string> * val =
             dynamic_cast<libMesh::Parameters::Parameter<std::string> *>(iter.second);
         const std::string & active = val->get();
         if (val != NULL && active == "")
           continue;
       }
 
       found = true;
       oss << spacing << "  " << std::left << std::setw(offset) << iter.first << " = ";
       // std::setw() takes an int
       int l_offset = 30;
 
       if (!_dump_mode || value != "INVALID")
       {
         // If the value has spaces, surround it with quotes, otherwise no quotes
         if (value.find(' ') != std::string::npos)
         {
           quotes = "'";
           l_offset -= 2;
         }
         else
           quotes = "";
         oss << quotes << value << quotes;
         l_offset -= value.size();
       }
       else if (_dump_mode && params.isParamRequired(iter.first))
       {
         oss << "(required)";
         l_offset -= 10;
       }
 
       // Documentation string
       if (_dump_mode)
       {
         std::vector<std::string> elements;
         std::string doc = params.getDocString(iter.first);
         if (MooseUtils::trim(doc) != "")
         {
           MooseUtils::tokenize(doc, elements, 68, " \t");
 
           for (auto & element : elements)
             MooseUtils::escape(element);
 
           oss << std::right << std::setw(l_offset) << "# " << elements[0];
           for (unsigned int i = 1; i < elements.size(); ++i)
             oss << " ...\n"
                 << "  " << std::setw(63) << "# " << elements[i];
         }
         const std::string group = params.getGroupName(iter.first);
         if (!group.empty())
         {
           if (MooseUtils::trim(doc) != "")
             oss << " ...\n"
                 << "  " << std::setw(70) << "# Group: " << group;
           else
             oss << std::right << std::setw(l_offset) << "# Group: " << group;
         }
       }
       oss << "\n";
     }
   }
 
   return oss.str();
 }

◆ seenIt()

void SyntaxTree::seenIt	(	const std::string &	prefix,
		const std::string &	item
	)

inherited

Definition at line 57 of file SyntaxTree.C.

Referenced by InputFileFormatter::printParams(), and YAMLFormatter::printParams().

 {
   _params_printed.insert(prefix + item);
 }

Member Data Documentation

◆ _dump_mode

bool InputFileFormatter::_dump_mode

protectedinherited

Definition at line 35 of file InputFileFormatter.h.

Referenced by InputFileFormatter::printParams().

◆ _input_file_record

std::vector<std::string> ExodusFormatter::_input_file_record

protected

Definition at line 28 of file ExodusFormatter.h.

Referenced by format(), and getInputFileRecord().

◆ _root

TreeNode* SyntaxTree::_root

protectedinherited

Definition at line 75 of file SyntaxTree.h.

Referenced by SyntaxTree::insertNode(), SyntaxTree::print(), and SyntaxTree::~SyntaxTree().

◆ _ss

std::stringstream ExodusFormatter::_ss

protected

Definition at line 27 of file ExodusFormatter.h.

Referenced by format(), and printInputFile().

◆ _use_long_names

bool SyntaxTree::_use_long_names

protectedinherited

Definition at line 76 of file SyntaxTree.h.

Referenced by SyntaxTree::isLongNames().

The documentation for this class was generated from the following files:

include/outputs/formatters/ExodusFormatter.h
src/outputs/formatters/ExodusFormatter.C

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ExodusFormatter()

Member Function Documentation

◆ format()

◆ getInputFileRecord()

◆ haveSeenIt()

◆ insertNode()

◆ isLongNames()

◆ postscript()

◆ preamble()

◆ preTraverse()

◆ print()

◆ printBlockClose()

◆ printBlockOpen()

◆ printInputFile()

◆ printParams()

◆ seenIt()

Member Data Documentation

◆ _dump_mode

◆ _input_file_record

◆ _root

◆ _ss

◆ _use_long_names