GEOS
Namespaces | Functions
OutputUtilities.hpp File Reference
#include "common/DataTypes.hpp"
#include "dataRepository/RestartFlags.hpp"
#include <set>

Go to the source code of this file.

Namespaces

 geos
 

Functions

void geos::outputUtilities::checkFieldRegistration (ElementRegionManager const &elemManager, NodeManager const &nodeManager, std::set< string > const &fieldNames, string const &outputName)
 Utility function that checks whether the field names provided by the user in fieldNames are actually registered somewhere. More...
 
bool geos::outputUtilities::isFieldPlotEnabled (dataRepository::PlotLevel const wrapperPlotLevel, dataRepository::PlotLevel const requiredPlotLevel, string const &wrapperName, std::set< string > const &fieldNames, integer const onlyPlotSpecifiedFieldNames)
 Utility function that checks whether a wrapper should be plotted or not. More...
 

Function Documentation

◆ checkFieldRegistration()

void geos::outputUtilities::checkFieldRegistration ( ElementRegionManager const &  elemManager,
NodeManager const &  nodeManager,
std::set< string > const &  fieldNames,
string const &  outputName 
)

Utility function that checks whether the field names provided by the user in fieldNames are actually registered somewhere.

Parameters
[in]elemManagerthe elementRegionManager
[in]nodeManagerthe nodeManager
[in]fieldNamesthe set of field names specified by the user in the xml file
[in]outputNamethe output name (i.e., VTKOutput or SiloOutput)

◆ isFieldPlotEnabled()

bool geos::outputUtilities::isFieldPlotEnabled ( dataRepository::PlotLevel const  wrapperPlotLevel,
dataRepository::PlotLevel const  requiredPlotLevel,
string const &  wrapperName,
std::set< string > const &  fieldNames,
integer const  onlyPlotSpecifiedFieldNames 
)

Utility function that checks whether a wrapper should be plotted or not.

Parameters
[in]wrapperPlotLevelthe plot level of the wrapper
[in]requiredPlotLevelthe plot level required by the user in the xml
[in]wrapperNamethe name of the wrapper
[in]fieldNamesthe set of field names specified by the user in the xml fiel
[in]onlyPlotSpecifiedFieldNamesthe flag that says whether we only plot the fields in fieldNames or not
Returns
true if the plot must be plotted, false otherwise