inp::OutputDeck Struct Reference

Structure to read input data for performing simulation output. More...

#include <outputDeck.h>

Collaboration diagram for inp::OutputDeck:

Public Member Functions
bool	isTagInOutput (const std::string &tag)
	Searches list of tags and returns true if the asked tag is in the list. More...
	OutputDeck ()
	Constructor.
void	print (int nt=0, int lvl=0) const
	Prints the information about the instance of the object. More...
std::string	printStr (int nt=0, int lvl=0) const
	Returns the string containing information about the instance of the object. More...

Data Fields
std::string	d_compressType
	Compressor type for .vtu files.
size_t	d_debug
	Flag specifying debug level.
size_t	d_dtOut
	Size of time steps (or frequency) for output operation.
size_t	d_dtOutCriteria
	Specify output frequency if output criteria is met. More...
size_t	d_dtOutOld
	Size of time steps (or frequency) for output operation.
std::string	d_outCriteria
	Specify output criteria to change output frequency. More...
std::vector< double >	d_outCriteriaParams
	List of parameters required in checking output criteria.
std::string	d_outFormat
	Output format: currently supports vtu, msh, legacy_vtk output. More...
std::vector< std::string >	d_outTags
	List of tags of data to be dumped.
std::string	d_path
	Output Path where the files will be written. More...
bool	d_performFEOut
	Flag specifying if element-node connectivity should not be dumped. More...

Detailed Description

Structure to read input data for performing simulation output.

Member Function Documentation

isTagInOutput()

bool inp::OutputDeck::isTagInOutput ( const std::string &  tag )

inline

Searches list of tags and returns true if the asked tag is in the list.

Parameters

tag	Tag to search

Returns

bool True or false If tag is find return true or else false

Referenced by material::pd::ElasticState::ElasticState(), and model::Output::Output().

Here is the caller graph for this function:

print()

void inp::OutputDeck::print ( int  nt = 0, int  lvl = 0  ) const

inline

Prints the information about the instance of the object.

Parameters

nt	Number of tabs to append before each line of string
lvl	Level of information sought (higher level means more information)

Here is the call graph for this function:

printStr()

std::string inp::OutputDeck::printStr ( int  nt = 0, int  lvl = 0  ) const

inline

Returns the string containing information about the instance of the object.

Parameters

nt	Number of tabs to append before each line of string
lvl	Level of information sought (higher level means more information)

Returns

string String containing information about this object

Referenced by print().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

d_dtOutCriteria

size_t inp::OutputDeck::d_dtOutCriteria

Specify output frequency if output criteria is met.

If criteria is met, then this number if used as output frequency.

Referenced by tools::pp::Compute::Compute(), and model::Output::Output().

d_outCriteria

std::string inp::OutputDeck::d_outCriteria

Specify output criteria to change output frequency.

Choices are:

• "none"
• max_Z
• max_Z_stop

Specify the method used in changing the output frequency. If not specified then we do not change the output frequency from d_dtOut.

d_outFormat

std::string inp::OutputDeck::d_outFormat

Output format: currently supports vtu, msh, legacy_vtk output.

Default is vtu format.

Referenced by tools::pp::Compute::Compute(), model::Output::Output(), and printStr().

d_path

std::string inp::OutputDeck::d_path

Output Path where the files will be written.

Default is current working directory

Referenced by model::Output::Output(), and printStr().

d_performFEOut

bool inp::OutputDeck::d_performFEOut

Flag specifying if element-node connectivity should not be dumped.

For large mesh, vtk writer crashes when writing element-node connectivity.

Referenced by model::Output::Output().

---

The documentation for this struct was generated from the following file:

• /root/project/src/inp/decks/outputDeck.h