GEOS
OutputUtilities.hpp
Go to the documentation of this file.
1 /*
2  * ------------------------------------------------------------------------------------------------------------
3  * SPDX-License-Identifier: LGPL-2.1-only
4  *
5  * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
6  * Copyright (c) 2018-2024 TotalEnergies
7  * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
8  * Copyright (c) 2023-2024 Chevron
9  * Copyright (c) 2019- GEOS/GEOSX Contributors
10  * All rights reserved
11  *
12  * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
13  * ------------------------------------------------------------------------------------------------------------
14  */
15 
20 #ifndef GEOS_FILEIO_OUTPUTS_OUTPUTUTILITIES_HPP_
21 #define GEOS_FILEIO_OUTPUTS_OUTPUTUTILITIES_HPP_
22 
23 #include "common/DataTypes.hpp"
25 
26 #include <set>
27 
28 namespace geos
29 {
30 
31 class ElementRegionManager;
32 class NodeManager;
33 
34 namespace outputUtilities
35 {
36 
44 void checkFieldRegistration( ElementRegionManager const & elemManager,
45  NodeManager const & nodeManager,
46  std::set< string > const & fieldNames,
47  string const & outputName );
48 
58 bool isFieldPlotEnabled( dataRepository::PlotLevel const wrapperPlotLevel,
59  dataRepository::PlotLevel const requiredPlotLevel,
60  string const & wrapperName,
61  std::set< string > const & fieldNames,
62  integer const onlyPlotSpecifiedFieldNames );
63 
64 } /* namespace outputUtilities */
65 
66 } /* namespace geos */
67 
68 #endif /* GEOS_FILEIO_OUTPUTS_OUTPUTILITIES_HPP_ */
void 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 ...
bool 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.
The ElementRegionManager class provides an interface to ObjectManagerBase in order to manage ElementR...
The NodeManager class provides an interface to ObjectManagerBase in order to manage node data.
Definition: NodeManager.hpp:46
std::int32_t integer
Signed integer type.
Definition: DataTypes.hpp:82