GRINS-0.8.0
qoi_output.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------bl-
2 //--------------------------------------------------------------------------
3 //
4 // GRINS - General Reacting Incompressible Navier-Stokes
5 //
6 // Copyright (C) 2014-2017 Paul T. Bauman, Roy H. Stogner
7 // Copyright (C) 2010-2013 The PECOS Development Team
8 //
9 // This library is free software; you can redistribute it and/or
10 // modify it under the terms of the Version 2.1 GNU Lesser General
11 // Public License as published by the Free Software Foundation.
12 //
13 // This library is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 // Lesser General Public License for more details.
17 //
18 // You should have received a copy of the GNU Lesser General Public
19 // License along with this library; if not, write to the Free Software
20 // Foundation, Inc. 51 Franklin Street, Fifth Floor,
21 // Boston, MA 02110-1301 USA
22 //
23 //-----------------------------------------------------------------------el-
24 
25 #ifndef GRINS_QOI_OUTPUT_H
26 #define GRINS_QOI_OUTPUT_H
27 
28 #include <string>
29 
30 // libMesh forward declarations
31 class GetPot;
32 namespace libMesh
33 {
34  namespace Parallel
35  {
36  class Communicator;
37  }
38 }
39 
40 namespace GRINS
41 {
42  // Forward declarations
43  class CompositeQoI;
44 
46 
52  class QoIOutput
53  {
54  public:
55 
56  QoIOutput( const GetPot & input );
57 
59 
61 
63  bool output_qoi_set() const
64  { return (_output_to_display || _output_to_file ); }
65 
67 
69  void output_qois( const CompositeQoI & qois, const libMesh::Parallel::Communicator & comm ) const;
70 
71  protected:
72 
74 
76 
77  std::string _file_prefix;
78 
79  };
80 
81 } // end namespace GRINS
82 
83 #endif // GRINS_QOI_OUTPUT_H
std::string _file_prefix
Definition: qoi_output.h:77
Encapsulate QoI output flags and functionality.
Definition: qoi_output.h:52
bool _output_to_display
Definition: qoi_output.h:73
bool output_qoi_set() const
Function to query whether any input options set to output qoi.
Definition: qoi_output.h:63
bool _output_to_file
Definition: qoi_output.h:75
GRINS namespace.
void output_qois(const CompositeQoI &qois, const libMesh::Parallel::Communicator &comm) const
Output the QoI values for all triggered output modes.
Definition: qoi_output.C:60
QoIOutput(const GetPot &input)
Definition: qoi_output.C:43

Generated on Tue Dec 19 2017 12:47:28 for GRINS-0.8.0 by  doxygen 1.8.9.1