www.mooseframework.org
XDA.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
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 // MOOSE includes
11 #include "XDA.h"
12 #include "MooseApp.h"
13 #include "FEProblem.h"
14 #include "MooseMesh.h"
15 
16 // libMesh includes
17 #include "libmesh/enum_xdr_mode.h"
18 
19 registerMooseObject("MooseApp", XDA);
20 registerMooseObjectAliased("MooseApp", XDA, "XDR");
21 
22 template <>
25 {
26  // Get the base class parameters
28 
29  // Add description for the XDA class
30  params.addClassDescription("Object for outputting data in the XDA/XDR format");
31 
32  /* Set a private parameter for controlling the output type (XDR = binary), the value
33  of this parameter is set by the AddOutputAction*/
34  params.addPrivateParam<bool>("_binary", false);
35 
36  // Return the InputParameters
37  return params;
38 }
39 
40 XDA::XDA(const InputParameters & parameters)
41  : OversampleOutput(parameters), _binary(getParam<bool>("_binary"))
42 {
43 }
44 
45 void
46 XDA::output(const ExecFlagType & /*type*/)
47 {
48  // Strings for the two filenames to be written
49  std::string es_name = filename();
50  std::string mesh_name = es_name;
51 
52  // Make sure the filename has an extension
53  if (es_name.size() < 4)
54  mooseError("Unacceptable filename, you must include an extension (.xda or .xdr).");
55 
56  // Insert the mesh suffix
57  mesh_name.insert(mesh_name.size() - 4, "_mesh");
58 
59  // Set the binary flag
60  XdrMODE mode = _binary ? ENCODE : WRITE;
61 
62  // Write the files
63  _mesh_ptr->getMesh().write(mesh_name);
64  _es_ptr->write(
65  es_name, mode, EquationSystems::WRITE_DATA | EquationSystems::WRITE_ADDITIONAL_DATA);
66  _file_num++;
67 }
68 
69 std::string
71 {
72  // Append the padded time step to the file base
73  std::ostringstream output;
74  output << _file_base << "_" << std::setw(_padding) << std::setprecision(0) << std::setfill('0')
75  << std::right << _file_num;
76 
77  if (_binary)
78  output << ".xdr";
79  else
80  output << ".xda";
81  return output.str();
82 }
Based class for providing re-positioning and oversampling support to output objects.
registerMooseObject("MooseApp", XDA)
virtual std::string filename() override
Returns the current filename, this method handles adding the timestep suffix.
Definition: XDA.C:70
void addPrivateParam(const std::string &name, const T &value)
These method add a parameter to the InputParameters object which can be retrieved like any other para...
bool _binary
Flag for binary output.
Definition: XDA.h:47
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
std::string _file_base
The base filename from the input paramaters.
Definition: FileOutput.h:81
InputParameters validParams< OversampleOutput >()
Class for output data to the XDAII format.
Definition: XDA.h:24
InputParameters validParams< XDA >()
Definition: XDA.C:24
void mooseError(Args &&... args) const
Definition: MooseObject.h:147
unsigned int _padding
Number of digits to pad the extensions.
Definition: FileOutput.h:87
MeshBase & getMesh()
Accessor for the underlying libMesh Mesh object.
Definition: MooseMesh.C:2567
EquationSystems * _es_ptr
Reference the the libMesh::EquationSystems object that contains the data.
Definition: Output.h:176
registerMooseObjectAliased("MooseApp", XDA, "XDR")
Class for containing MooseEnum item information.
Definition: MooseEnumItem.h:21
MooseMesh * _mesh_ptr
A convenience pointer to the current mesh (reference or displaced depending on "use_displaced") ...
Definition: Output.h:179
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump...
unsigned int & _file_num
A file number counter, initialized to 0 (this must be controlled by the child class, see Exodus)
Definition: FileOutput.h:84
virtual void output(const ExecFlagType &type) override
Overload the Output::output method, this is required for XDA output due to the method utlized for out...
Definition: XDA.C:46
XDA(const InputParameters &parameters)
Class consturctor.
Definition: XDA.C:40