VTXSchema.h

Go to the documentation of this file.

/*=========================================================================
 
 Program:   Visualization Toolkit
 Module:    VTXSchema.h
 
 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
 All rights reserved.
 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
 
 This software is distributed WITHOUT ANY WARRANTY; without even
 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 PURPOSE.  See the above copyright notice for more information.
 
 =========================================================================*/
 
/*
 * VTXSchema.h : abstract class from which all supported adios2 schemas
 *                  derive from. Provide common functionality.
 *
 *  Created on: May 6, 2019
 *      Author: William F Godoy godoywf@ornl.gov
 */
 
#ifndef VTK_IO_ADIOS2_VTX_SCHEMA_VTXSchema_h
#define VTK_IO_ADIOS2_VTX_SCHEMA_VTXSchema_h
 
#include <map>
#include <string>
 
#include "vtkMultiBlockDataSet.h"
 
#include <adios2.h>
 
#include "VTX/common/VTXDataArray.h"
#include "VTX/common/VTXTypes.h"
 
namespace vtx
{
class VTXSchema
{
public:
  const std::string Type;
 
  std::string Schema;
 
  std::map<double, size_t> Times;
 
  VTXSchema(
    const std::string& type, const std::string& schema, adios2::IO& io, adios2::Engine& engine);
 
  // can't use = default, due to forward class not defined
  virtual ~VTXSchema();
 
  void Fill(vtkMultiBlockDataSet* multiBlock, const size_t step = 0);
 
protected:
  adios2::IO& IO;
  adios2::Engine& Engine;
 
  virtual void Init() = 0;
  virtual void InitTimes() = 0;
 
  virtual void DoFill(vtkMultiBlockDataSet* multiBlock, const size_t step) = 0;
  virtual void ReadPiece(const size_t step, const size_t pieceID) = 0;
 
  void GetTimes(const std::string& variableName = "");
  void GetDataArray(
    const std::string& variableName, types::DataArray& dataArray, const size_t step = 0);
 
#define declare_type(T)                                                                            \
  virtual void SetDimensions(                                                                      \
    adios2::Variable<T> variable, const types::DataArray& dataArray, const size_t step);           \
                                                                                                   \
  virtual void SetBlocks(                                                                          \
    adios2::Variable<T> variable, types::DataArray& dataArray, const size_t step);
 
  VTK_IO_ADIOS2_VTX_ARRAY_TYPE(declare_type)
#undef declare_type
 
private:
  template <class T>
  void GetDataArrayCommon(
    adios2::Variable<T> variable, types::DataArray& dataArray, const size_t step);
 
  template <class T>
  void GetDataArrayGlobal(
    adios2::Variable<T> variable, types::DataArray& dataArray, const size_t step);
 
  template <class T>
  void GetDataArrayLocal(
    adios2::Variable<T> variable, types::DataArray& dataArray, const size_t step);
 
  template <class T>
  void GetDataValueGlobal(
    adios2::Variable<T> variable, types::DataArray& dataArray, const size_t step);
 
  template <class T>
  void GetTimesCommon(const std::string& variableName);
 
  template <class T>
  void InitDataArray(const std::string& name, const size_t elements, const size_t components,
    types::DataArray& dataArray);
};
 
} // end namespace vtx
 
#endif /* VTK_IO_ADIOS2_VTX_SCHEMA_VTXSchema_h */