https://mooseframework.inl.gov
Loading...
Searching...
No Matches
CSV.h
Go to the documentation of this file.
1//* This file is part of the MOOSE framework
2//* https://mooseframework.inl.gov
3//*
4//* All rights reserved, see COPYRIGHT for full restrictions
5//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6//*
7//* Licensed under LGPL 2.1, please see LICENSE for details
8//* https://www.gnu.org/licenses/lgpl-2.1.html
9
10#pragma once
11
12// MOOSE includes
13#include "TableOutput.h"
14
20class CSV : public TableOutput
21{
22public:
24
34
35protected:
36 using Output::output;
37
41 virtual void output() override;
42
47 virtual std::string filename() override;
48
53 void initialSetup() override;
54
58 virtual void outputScalarVariables() override;
59
63 virtual void outputPostprocessors() override;
64
68 virtual void outputVectorPostprocessors() override;
69
73 virtual void outputReporters() override;
74
79 std::string getVectorPostprocessorFileName(const std::string & vpp_name,
80 bool include_time_step,
81 bool is_distributed);
82
83private:
85 bool _align;
86
88 unsigned int _precision;
89
92
94 std::string _delimiter;
95
98
101
103 const bool _sort_columns;
104
107
110
113
115 // The pair is composed of the complete filename (foo_variable_0001.csv), the incomplete name
116 // (foo_variable) to which the _FINAL or _LATEST is to be applied, and the "is_distributed" flag
117 std::vector<std::tuple<std::string, std::string, bool>> _latest_vpp_filenames;
118
122 std::string getVectorPostprocessorFilePrefix(const std::string & vpp_name);
123};
Based class for adding basic filename support to output base class.
Definition CSV.h:21
std::string getVectorPostprocessorFileName(const std::string &vpp_name, bool include_time_step, bool is_distributed)
Generates a filename pattern for Vectorpostprocessors filebase + VPP name + time step + "....
Definition CSV.C:160
bool _scientific_notation
Flag for writing floating point values in scientific notation.
Definition CSV.h:91
virtual void outputReporters() override
Sets the write flag and calls TableOutput::outputVectorPostprocessors()
Definition CSV.C:152
virtual void output() override
Output the table to a *.csv file.
Definition CSV.C:199
bool _create_final_symlink
Flag for creating a _FINAL symlink.
Definition CSV.h:109
bool _write_all_table
Flag for writing scalar and/or postprocessor data.
Definition CSV.h:97
virtual std::string filename() override
The filename for the output file.
Definition CSV.C:125
void initialSetup() override
Setup the CSV output If restarting and the append_restart flag is false, then the output data is clea...
Definition CSV.C:75
unsigned int _precision
Decimal digits per number in the CSV file.
Definition CSV.h:88
virtual void outputPostprocessors() override
Sets the write flag and calls TableOutput::outputPostprocessors()
Definition CSV.C:138
const bool _sort_columns
Flag for sorting column names.
Definition CSV.h:103
std::string getVectorPostprocessorFilePrefix(const std::string &vpp_name)
Returns the filename without the time/timestep information.
Definition CSV.C:294
std::string _delimiter
The delimiter used when writing the CSV file.
Definition CSV.h:94
bool _align
Flag for aligning data in .csv file.
Definition CSV.h:85
std::vector< std::tuple< std::string, std::string, bool > > _latest_vpp_filenames
Current list of VPP filenames for creating _LATEST/_FINAL symlinks.
Definition CSV.h:117
static InputParameters validParams()
Definition CSV.C:18
virtual void outputVectorPostprocessors() override
Sets the write flag and calls TableOutput::outputVectorPostprocessors()
Definition CSV.C:145
virtual void outputScalarVariables() override
Sets the write flag and calls TableOutput::outputScalarVariables()
Definition CSV.C:131
bool _create_latest_symlink
Flag for creating a _LATEST symlink.
Definition CSV.h:112
bool _recovering
Flag indicating MOOSE is recovering via –recover command-line option.
Definition CSV.h:106
bool _write_vector_table
Flag for writing vector postprocessor data.
Definition CSV.h:100
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
const InputParameters & parameters() const
Get the parameters of the object.
Definition MooseBase.h:131
virtual void output()=0
Overload this function with the desired output activities.
Base class for scalar variables and postprocessors output objects.
Definition TableOutput.h:29